src/mesa/state_tracker/st_texture.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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 #ifndef ST_TEXTURE_H
  29 #define ST_TEXTURE_H
  30
  31
  32 #include "pipe/p_context.h"
  33 #include "util/u_sampler.h"
  34
  35 #include "main/mtypes.h"
  36
  37
  38 struct pipe_resource;
  39
  40
  41 /**
  42  * Subclass of gl_texure_image.
  43  */
  44 struct st_texture_image
  45 {
  46    struct gl_texture_image base;
  47
  48    /** Used to store texture data that doesn't fit in the parent
  49     * object's mipmap buffer.
  50     */
  51    GLubyte *TexData;
  52
  53    /* If stImage->pt != NULL, image data is stored here.
  54     * Else if stImage->TexData != NULL, image is stored there.
  55     * Else there is no image data.
  56     */
  57    struct pipe_resource *pt;
  58
  59    struct pipe_transfer *transfer;
  60 };
  61
  62
  63 /**
  64  * Subclass of gl_texure_object.
  65  */
  66 struct st_texture_object
  67 {
  68    struct gl_texture_object base;       /* The "parent" object */
  69
  70    /* The texture must include at levels [0..lastLevel] once validated:
  71     */
  72    GLuint lastLevel;
  73
  74    /** The size of the level=0 mipmap image.
  75     * Note that the number of 1D array layers will be in height0 and the
  76     * number of 2D array layers will be in depth0, as in GL.
  77     */
  78    GLuint width0, height0, depth0;
  79
  80    /* On validation any active images held in main memory or in other
  81     * textures will be copied to this texture and the old storage freed.
  82     */
  83    struct pipe_resource *pt;
  84
  85    /* Number of views in sampler_views array */
  86    GLuint num_sampler_views;
  87
  88    /* Array of sampler views (one per context) attached to this texture
  89     * object. Created lazily on first binding in context.
  90     */
  91    struct pipe_sampler_view **sampler_views;
  92
  93    /* True if this texture comes from the window system. Such a texture
  94     * cannot be reallocated and the format can only be changed with a sampler
  95     * view or a surface.
  96     */
  97    GLboolean surface_based;
  98
  99    /* If surface_based is true, this format should be used for all sampler
 100     * views and surfaces instead of pt->format.
 101     */
 102    enum pipe_format surface_format;
 103 };
 104
 105
 106 static INLINE struct st_texture_image *
 107 st_texture_image(struct gl_texture_image *img)
 108 {
 109    return (struct st_texture_image *) img;
 110 }
 111
 112 static INLINE struct st_texture_object *
 113 st_texture_object(struct gl_texture_object *obj)
 114 {
 115    return (struct st_texture_object *) obj;
 116 }
 117
 118 static INLINE const struct st_texture_object *
 119 st_texture_object_const(const struct gl_texture_object *obj)
 120 {
 121    return (const struct st_texture_object *) obj;
 122 }
 123
 124
 125 static INLINE struct pipe_resource *
 126 st_get_texobj_resource(struct gl_texture_object *texObj)
 127 {
 128    struct st_texture_object *stObj = st_texture_object(texObj);
 129    return stObj ? stObj->pt : NULL;
 130 }
 131
 132
 133 static INLINE struct pipe_resource *
 134 st_get_stobj_resource(struct st_texture_object *stObj)
 135 {
 136    return stObj ? stObj->pt : NULL;
 137 }
 138
 139
 140 static INLINE struct pipe_sampler_view *
 141 st_create_texture_sampler_view_format(struct pipe_context *pipe,
 142                                       struct pipe_resource *texture,
 143                                       enum pipe_format format)
 144 {
 145    struct pipe_sampler_view templ;
 146
 147    u_sampler_view_default_template(&templ, texture, format);
 148
 149    return pipe->create_sampler_view(pipe, texture, &templ);
 150 }
 151
 152 static INLINE struct pipe_sampler_view *
 153 st_create_texture_sampler_view(struct pipe_context *pipe,
 154                                struct pipe_resource *texture)
 155 {
 156    return st_create_texture_sampler_view_format(pipe, texture,
 157                                                 texture->format);
 158 }
 159
 160
 161
 162 extern struct pipe_resource *
 163 st_texture_create(struct st_context *st,
 164                   enum pipe_texture_target target,
 165                   enum pipe_format format,
 166                   GLuint last_level,
 167                   GLuint width0,
 168                   GLuint height0,
 169                   GLuint depth0,
 170                   GLuint layers,
 171                   GLuint nr_samples,
 172                   GLuint tex_usage );
 173
 174
 175 extern void
 176 st_gl_texture_dims_to_pipe_dims(GLenum texture,
 177                                 GLuint widthIn,
 178                                 GLuint heightIn,
 179                                 GLuint depthIn,
 180                                 GLuint *widthOut,
 181                                 GLuint *heightOut,
 182                                 GLuint *depthOut,
 183                                 GLuint *layersOut);
 184
 185 /* Check if an image fits into an existing texture object.
 186  */
 187 extern GLboolean
 188 st_texture_match_image(const struct pipe_resource *pt,
 189                        const struct gl_texture_image *image);
 190
 191 /* Return a pointer to an image within a texture.  Return image stride as
 192  * well.
 193  */
 194 extern GLubyte *
 195 st_texture_image_map(struct st_context *st, struct st_texture_image *stImage,
 196                      enum pipe_transfer_usage usage,
 197                      GLuint x, GLuint y, GLuint z,
 198                      GLuint w, GLuint h, GLuint d);
 199
 200 extern void
 201 st_texture_image_unmap(struct st_context *st,
 202                        struct st_texture_image *stImage);
 203
 204
 205 /* Return pointers to each 2d slice within an image.  Indexed by depth
 206  * value.
 207  */
 208 extern const GLuint *
 209 st_texture_depth_offsets(struct pipe_resource *pt, GLuint level);
 210
 211
 212 /* Upload an image into a texture
 213  */
 214 extern void
 215 st_texture_image_data(struct st_context *st,
 216                       struct pipe_resource *dst,
 217                       GLuint face, GLuint level, void *src,
 218                       GLuint src_row_pitch, GLuint src_image_pitch);
 219
 220
 221 /* Copy an image between two textures
 222  */
 223 extern void
 224 st_texture_image_copy(struct pipe_context *pipe,
 225                       struct pipe_resource *dst, GLuint dstLevel,
 226                       struct pipe_resource *src, GLuint srcLevel,
 227                       GLuint face);
 228
 229
 230 extern struct pipe_resource *
 231 st_create_color_map_texture(struct gl_context *ctx);
 232
 233 extern struct pipe_sampler_view **
 234 st_texture_get_sampler_view(struct st_context *st,
 235                             struct st_texture_object *stObj);
 236
 237 extern void
 238 st_texture_release_sampler_view(struct st_context *st,
 239                                 struct st_texture_object *stObj);
 240
 241 extern void
 242 st_texture_release_all_sampler_views(struct st_texture_object *stObj);
 243
 244 #endif