Home | History | Annotate | Download | only in translate
      1 /*
      2  * Copyright 2008 VMware, Inc.
      3  * All Rights Reserved.
      4  *
      5  * Permission is hereby granted, free of charge, to any person obtaining a
      6  * copy of this software and associated documentation files (the "Software"),
      7  * to deal in the Software without restriction, including without limitation
      8  * on the rights to use, copy, modify, merge, publish, distribute, sub
      9  * license, and/or sell copies of the Software, and to permit persons to whom
     10  * the Software is furnished to do so, subject to the following conditions:
     11  *
     12  * The above copyright notice and this permission notice (including the next
     13  * paragraph) shall be included in all copies or substantial portions of the
     14  * Software.
     15  *
     16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     18  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
     19  * VMWARE AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
     20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
     21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
     22  * USE OR OTHER DEALINGS IN THE SOFTWARE.
     23  */
     24 
     25 
     26 /**
     27  * Vertex fetch/store/convert code.  This functionality is used in two places:
     28  * 1. Vertex fetch/convert - to grab vertex data from incoming vertex
     29  *    arrays and convert to format needed by vertex shaders.
     30  * 2. Vertex store/emit - to convert simple float[][4] vertex attributes
     31  *    (which is the organization used throughout the draw/prim pipeline) to
     32  *    hardware-specific formats and emit into hardware vertex buffers.
     33  *
     34  *
     35  * Authors:
     36  *    Keith Whitwell <keithw (at) vmware.com>
     37  */
     38 
     39 #ifndef _TRANSLATE_H
     40 #define _TRANSLATE_H
     41 
     42 
     43 #include "pipe/p_compiler.h"
     44 #include "pipe/p_format.h"
     45 #include "pipe/p_state.h"
     46 
     47 /**
     48  * Translate has to work on one more attribute because
     49  * the draw module has to be able to pass the vertex
     50  * position even if the fragment shader already consumes
     51  * PIPE_MAX_ATTRIBS inputs.
     52  */
     53 #define TRANSLATE_MAX_ATTRIBS (PIPE_MAX_ATTRIBS + 1)
     54 
     55 enum translate_element_type {
     56    TRANSLATE_ELEMENT_NORMAL,
     57    TRANSLATE_ELEMENT_INSTANCE_ID
     58 };
     59 
     60 struct translate_element
     61 {
     62    enum translate_element_type type;
     63    enum pipe_format input_format;
     64    enum pipe_format output_format;
     65    unsigned input_buffer:8;
     66    unsigned input_offset:24;
     67    unsigned instance_divisor;
     68    unsigned output_offset;
     69 };
     70 
     71 
     72 struct translate_key {
     73    unsigned output_stride;
     74    unsigned nr_elements;
     75    struct translate_element element[TRANSLATE_MAX_ATTRIBS];
     76 };
     77 
     78 
     79 struct translate;
     80 
     81 
     82 typedef void (PIPE_CDECL *run_elts_func)(struct translate *,
     83                                          const unsigned *elts,
     84                                          unsigned count,
     85                                          unsigned start_instance,
     86                                          unsigned instance_id,
     87                                          void *output_buffer);
     88 
     89 typedef void (PIPE_CDECL *run_elts16_func)(struct translate *,
     90                                            const uint16_t *elts,
     91                                            unsigned count,
     92                                            unsigned start_instance,
     93                                            unsigned instance_id,
     94                                            void *output_buffer);
     95 
     96 typedef void (PIPE_CDECL *run_elts8_func)(struct translate *,
     97                                           const uint8_t *elts,
     98                                           unsigned count,
     99                                           unsigned start_instance,
    100                                           unsigned instance_id,
    101                                           void *output_buffer);
    102 
    103 typedef void (PIPE_CDECL *run_func)(struct translate *,
    104                                     unsigned start,
    105                                     unsigned count,
    106                                     unsigned start_instance,
    107                                     unsigned instance_id,
    108                                     void *output_buffer);
    109 
    110 struct translate {
    111    struct translate_key key;
    112 
    113    void (*release)( struct translate * );
    114 
    115    void (*set_buffer)( struct translate *,
    116 		       unsigned i,
    117 		       const void *ptr,
    118 		       unsigned stride,
    119 		       unsigned max_index );
    120 
    121    run_elts_func run_elts;
    122    run_elts16_func run_elts16;
    123    run_elts8_func run_elts8;
    124    run_func run;
    125 };
    126 
    127 
    128 
    129 struct translate *translate_create( const struct translate_key *key );
    130 
    131 boolean translate_is_output_format_supported(enum pipe_format format);
    132 
    133 static inline int translate_keysize( const struct translate_key *key )
    134 {
    135    return 2 * sizeof(int) + key->nr_elements * sizeof(struct translate_element);
    136 }
    137 
    138 static inline int translate_key_compare( const struct translate_key *a,
    139                                          const struct translate_key *b )
    140 {
    141    int keysize_a = translate_keysize(a);
    142    int keysize_b = translate_keysize(b);
    143 
    144    if (keysize_a != keysize_b) {
    145       return keysize_a - keysize_b;
    146    }
    147    return memcmp(a, b, keysize_a);
    148 }
    149 
    150 
    151 static inline void translate_key_sanitize( struct translate_key *a )
    152 {
    153    int keysize = translate_keysize(a);
    154    char *ptr = (char *)a;
    155    memset(ptr + keysize, 0, sizeof(*a) - keysize);
    156 }
    157 
    158 
    159 /*******************************************************************************
    160  *  Private:
    161  */
    162 struct translate *translate_sse2_create( const struct translate_key *key );
    163 
    164 struct translate *translate_generic_create( const struct translate_key *key );
    165 
    166 boolean translate_generic_is_output_format_supported(enum pipe_format format);
    167 
    168 #endif
    169