src/gallium/auxiliary/util/u_format.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 Vmware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28
  29 #ifndef U_FORMAT_H
  30 #define U_FORMAT_H
  31
  32
  33 #include "pipe/p_format.h"
  34
  35
  36 enum util_format_layout {
  37    UTIL_FORMAT_LAYOUT_SCALAR = 0,
  38    UTIL_FORMAT_LAYOUT_ARITH = 1,
  39    UTIL_FORMAT_LAYOUT_ARRAY = 2,
  40    UTIL_FORMAT_LAYOUT_YUV = 3,
  41    UTIL_FORMAT_LAYOUT_DXT = 4
  42 };
  43
  44
  45 struct util_format_block
  46 {
  47    /** Block width in pixels */
  48    unsigned width;
  49
  50    /** Block height in pixels */
  51    unsigned height;
  52
  53    /** Block size in bytes */
  54    unsigned bits;
  55 };
  56
  57
  58 enum util_format_type {
  59    UTIL_FORMAT_TYPE_VOID = 0,
  60    UTIL_FORMAT_TYPE_UNSIGNED = 1,
  61    UTIL_FORMAT_TYPE_SIGNED = 2,
  62    UTIL_FORMAT_TYPE_FIXED = 3,
  63    UTIL_FORMAT_TYPE_FLOAT = 4
  64 };
  65
  66
  67 enum util_format_swizzle {
  68    UTIL_FORMAT_SWIZZLE_X = 0,
  69    UTIL_FORMAT_SWIZZLE_Y = 1,
  70    UTIL_FORMAT_SWIZZLE_Z = 2,
  71    UTIL_FORMAT_SWIZZLE_W = 3,
  72    UTIL_FORMAT_SWIZZLE_0 = 4,
  73    UTIL_FORMAT_SWIZZLE_1 = 5,
  74    UTIL_FORMAT_SWIZZLE_NONE = 6
  75 };
  76
  77
  78 enum util_format_colorspace {
  79    UTIL_FORMAT_COLORSPACE_RGB = 0,
  80    UTIL_FORMAT_COLORSPACE_SRGB = 1,
  81    UTIL_FORMAT_COLORSPACE_YUV = 2,
  82    UTIL_FORMAT_COLORSPACE_ZS = 3,
  83 };
  84
  85
  86 struct util_format_channel_description
  87 {
  88    unsigned type:6;
  89    unsigned normalized:1;
  90    unsigned size:9;
  91 };
  92
  93
  94 struct util_format_description
  95 {
  96    enum pipe_format format;
  97    const char *name;
  98    struct util_format_block block;
  99    enum util_format_layout layout;
 100    struct util_format_channel_description channel[4];
 101    unsigned char swizzle[4];
 102    enum util_format_colorspace colorspace;
 103 };
 104
 105
 106 extern const struct util_format_description
 107 util_format_description_table[];
 108
 109
 110 const struct util_format_description *
 111 util_format_description(enum pipe_format format);
 112
 113
 114 /*
 115  * Format query functions.
 116  */
 117
 118 static INLINE boolean
 119 util_format_is_compressed(enum pipe_format format)
 120 {
 121    const struct util_format_description *desc = util_format_description(format);
 122
 123    assert(format);
 124    if (!format) {
 125       return FALSE;
 126    }
 127
 128    return desc->layout == UTIL_FORMAT_LAYOUT_DXT ? TRUE : FALSE;
 129 }
 130
 131
 132 /*
 133  * Format access functions.
 134  */
 135
 136 void
 137 util_format_read_4f(enum pipe_format format,
 138                     float *dst, unsigned dst_stride,
 139                     const void *src, unsigned src_stride,
 140                     unsigned x, unsigned y, unsigned w, unsigned h);
 141
 142 void
 143 util_format_write_4f(enum pipe_format format,
 144                      const float *src, unsigned src_stride,
 145                      void *dst, unsigned dst_stride,
 146                      unsigned x, unsigned y, unsigned w, unsigned h);
 147
 148 void
 149 util_format_read_4ub(enum pipe_format format,
 150                      uint8_t *dst, unsigned dst_stride,
 151                      const void *src, unsigned src_stride,
 152                      unsigned x, unsigned y, unsigned w, unsigned h);
 153
 154 void
 155 util_format_write_4ub(enum pipe_format format,
 156                       const uint8_t *src, unsigned src_stride,
 157                       void *dst, unsigned dst_stride,
 158                       unsigned x, unsigned y, unsigned w, unsigned h);
 159
 160 #endif /* ! U_FORMAT_H */