src/mesa/state_tracker/st_texture.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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 #ifndef ST_TEXTURE_H
  29 #define ST_TEXTURE_H
  30
  31
  32 #include "main/mtypes.h"
  33
  34 struct pipe_context;
  35 struct pipe_texture;
  36
  37
  38 struct st_texture_image
  39 {
  40    struct gl_texture_image base;
  41
  42    /* These aren't stored in gl_texture_image
  43     */
  44    GLuint level;
  45    GLuint face;
  46
  47    /* If stImage->pt != NULL, image data is stored here.
  48     * Else if stImage->base.Data != NULL, image is stored there.
  49     * Else there is no image data.
  50     */
  51    struct pipe_texture *pt;
  52
  53    struct pipe_transfer *transfer;
  54 };
  55
  56
  57
  58 struct st_texture_object
  59 {
  60    struct gl_texture_object base;       /* The "parent" object */
  61
  62    /* The texture must include at levels [0..lastLevel] once validated:
  63     */
  64    GLuint lastLevel;
  65
  66    /* On validation any active images held in main memory or in other
  67     * textures will be copied to this texture and the old storage freed.
  68     */
  69    struct pipe_texture *pt;
  70
  71    GLboolean teximage_realloc;
  72
  73    /* True if there is/was a surface bound to this texture object.  It helps
  74     * track whether the texture object is surface based or not.
  75     */
  76    GLboolean surface_based;
  77 };
  78
  79
  80 static INLINE struct st_texture_image *
  81 st_texture_image(struct gl_texture_image *img)
  82 {
  83    return (struct st_texture_image *) img;
  84 }
  85
  86 static INLINE struct st_texture_object *
  87 st_texture_object(struct gl_texture_object *obj)
  88 {
  89    return (struct st_texture_object *) obj;
  90 }
  91
  92
  93 static INLINE struct pipe_texture *
  94 st_get_texobj_texture(struct gl_texture_object *texObj)
  95 {
  96    struct st_texture_object *stObj = st_texture_object(texObj);
  97    return stObj ? stObj->pt : NULL;
  98 }
  99
 100
 101 static INLINE struct pipe_texture *
 102 st_get_stobj_texture(struct st_texture_object *stObj)
 103 {
 104    return stObj ? stObj->pt : NULL;
 105 }
 106
 107
 108 extern struct pipe_texture *
 109 st_texture_create(struct st_context *st,
 110                   enum pipe_texture_target target,
 111                   enum pipe_format format,
 112                   GLuint last_level,
 113                   GLuint width0,
 114                   GLuint height0,
 115                   GLuint depth0,
 116                   GLuint tex_usage );
 117
 118
 119 /* Check if an image fits into an existing texture object.
 120  */
 121 extern GLboolean
 122 st_texture_match_image(const struct pipe_texture *pt,
 123                        const struct gl_texture_image *image,
 124                        GLuint face, GLuint level);
 125
 126 /* Return a pointer to an image within a texture.  Return image stride as
 127  * well.
 128  */
 129 extern GLubyte *
 130 st_texture_image_map(struct st_context *st,
 131                      struct st_texture_image *stImage,
 132                      GLuint zoffset,
 133                      enum pipe_transfer_usage usage,
 134                      unsigned x, unsigned y,
 135                      unsigned w, unsigned h);
 136
 137 extern void
 138 st_texture_image_unmap(struct st_context *st,
 139                        struct st_texture_image *stImage);
 140
 141
 142 /* Return pointers to each 2d slice within an image.  Indexed by depth
 143  * value.
 144  */
 145 extern const GLuint *
 146 st_texture_depth_offsets(struct pipe_texture *pt, GLuint level);
 147
 148
 149 /* Return the linear offset of an image relative to the start of its region.
 150  */
 151 extern GLuint
 152 st_texture_image_offset(const struct pipe_texture *pt,
 153                         GLuint face, GLuint level);
 154
 155 extern GLuint
 156 st_texture_texel_offset(const struct pipe_texture * pt,
 157                         GLuint face, GLuint level,
 158                         GLuint col, GLuint row, GLuint img);
 159
 160
 161 /* Upload an image into a texture
 162  */
 163 extern void
 164 st_texture_image_data(struct st_context *st,
 165                       struct pipe_texture *dst,
 166                       GLuint face, GLuint level, void *src,
 167                       GLuint src_row_pitch, GLuint src_image_pitch);
 168
 169
 170 /* Copy an image between two textures
 171  */
 172 extern void
 173 st_texture_image_copy(struct pipe_context *pipe,
 174                       struct pipe_texture *dst, GLuint dstLevel,
 175                       struct pipe_texture *src,
 176                       GLuint face);
 177
 178 extern void
 179 st_teximage_flush_before_map(struct st_context *st,
 180                              struct pipe_texture *pt,
 181                              unsigned int face,
 182                              unsigned int level,
 183                              enum pipe_transfer_usage usage);
 184 #endif