1 /**
2 * \file teximage.h
3 * Texture images manipulation functions.
4 */
5
6 /*
7 * Mesa 3-D graphics library
8 *
9 * Copyright (C) 1999-2005 Brian Paul All Rights Reserved.
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27 * OTHER DEALINGS IN THE SOFTWARE.
28 */
29
30
31 #ifndef TEXIMAGE_H
32 #define TEXIMAGE_H
33
34
35 #include "mtypes.h"
36 #include "formats.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /** Is the given value one of the 6 cube faces? */
43 static inline GLboolean
_mesa_is_cube_face(GLenum target)44 _mesa_is_cube_face(GLenum target)
45 {
46 return (target >= GL_TEXTURE_CUBE_MAP_POSITIVE_X &&
47 target <= GL_TEXTURE_CUBE_MAP_NEGATIVE_Z);
48 }
49
50
51 /**
52 * Return number of faces for a texture target. This will be 6 for
53 * cube maps and 1 otherwise.
54 * NOTE: this function is not used for cube map arrays which operate
55 * more like 2D arrays than cube maps.
56 */
57 static inline GLuint
_mesa_num_tex_faces(GLenum target)58 _mesa_num_tex_faces(GLenum target)
59 {
60 switch (target) {
61 case GL_TEXTURE_CUBE_MAP:
62 case GL_PROXY_TEXTURE_CUBE_MAP:
63 return 6;
64 default:
65 return 1;
66 }
67 }
68
69
70 /**
71 * If the target is GL_TEXTURE_CUBE_MAP, return one of the
72 * GL_TEXTURE_CUBE_MAP_POSITIVE/NEGATIVE_X/Y/Z targets corresponding to
73 * the face parameter.
74 * Else, return target as-is.
75 */
76 static inline GLenum
_mesa_cube_face_target(GLenum target,unsigned face)77 _mesa_cube_face_target(GLenum target, unsigned face)
78 {
79 if (target == GL_TEXTURE_CUBE_MAP) {
80 assert(face < 6);
81 return GL_TEXTURE_CUBE_MAP_POSITIVE_X + face;
82 }
83 else {
84 return target;
85 }
86 }
87
88
89 /**
90 * For cube map faces, return a face index in [0,5].
91 * For other targets return 0;
92 */
93 static inline GLuint
_mesa_tex_target_to_face(GLenum target)94 _mesa_tex_target_to_face(GLenum target)
95 {
96 if (_mesa_is_cube_face(target))
97 return (GLuint) target - (GLuint) GL_TEXTURE_CUBE_MAP_POSITIVE_X;
98 else
99 return 0;
100 }
101
102
103 /** Are any of the dimensions of given texture equal to zero? */
104 static inline GLboolean
_mesa_is_zero_size_texture(const struct gl_texture_image * texImage)105 _mesa_is_zero_size_texture(const struct gl_texture_image *texImage)
106 {
107 return (texImage->Width == 0 ||
108 texImage->Height == 0 ||
109 texImage->Depth == 0);
110 }
111
112 /** \name Internal functions */
113 /*@{*/
114
115 extern GLboolean
116 _mesa_is_proxy_texture(GLenum target);
117
118 extern bool
119 _mesa_is_array_texture(GLenum target);
120
121
122 extern void
123 _mesa_delete_texture_image( struct gl_context *ctx,
124 struct gl_texture_image *teximage );
125
126
127 extern void
128 _mesa_init_teximage_fields(struct gl_context *ctx,
129 struct gl_texture_image *img,
130 GLsizei width, GLsizei height, GLsizei depth,
131 GLint border, GLenum internalFormat,
132 mesa_format format);
133 extern void
134 _mesa_init_teximage_fields_ms(struct gl_context *ctx,
135 struct gl_texture_image *img,
136 GLsizei width, GLsizei height, GLsizei depth,
137 GLint border, GLenum internalFormat,
138 mesa_format format,
139 GLuint numSamples,
140 GLboolean fixedSampleLocations);
141
142
143 extern mesa_format
144 _mesa_choose_texture_format(struct gl_context *ctx,
145 struct gl_texture_object *texObj,
146 GLenum target, GLint level,
147 GLenum internalFormat, GLenum format, GLenum type);
148
149 extern void
150 _mesa_update_fbo_texture(struct gl_context *ctx,
151 struct gl_texture_object *texObj,
152 GLuint face, GLuint level);
153
154 extern void
155 _mesa_clear_texture_image(struct gl_context *ctx,
156 struct gl_texture_image *texImage);
157
158
159 extern struct gl_texture_image *
160 _mesa_select_tex_image(const struct gl_texture_object *texObj,
161 GLenum target, GLint level);
162
163
164 extern struct gl_texture_image *
165 _mesa_get_tex_image(struct gl_context *ctx, struct gl_texture_object *texObj,
166 GLenum target, GLint level);
167
168 mesa_format
169 _mesa_get_texbuffer_format(const struct gl_context *ctx, GLenum internalFormat);
170
171 /**
172 * Return the base-level texture image for the given texture object.
173 */
174 static inline const struct gl_texture_image *
_mesa_base_tex_image(const struct gl_texture_object * texObj)175 _mesa_base_tex_image(const struct gl_texture_object *texObj)
176 {
177 return texObj->Image[0][texObj->Attrib.BaseLevel];
178 }
179
180
181 extern GLint
182 _mesa_max_texture_levels(const struct gl_context *ctx, GLenum target);
183
184
185 extern GLboolean
186 _mesa_test_proxy_teximage(struct gl_context *ctx, GLenum target,
187 GLuint numLevels, GLint level,
188 mesa_format format, GLuint numSamples,
189 GLint width, GLint height, GLint depth);
190
191 extern GLboolean
192 _mesa_target_can_be_compressed(const struct gl_context *ctx, GLenum target,
193 GLenum intFormat, GLenum *error);
194
195 extern GLint
196 _mesa_get_texture_dimensions(GLenum target);
197
198 extern GLboolean
199 _mesa_tex_target_is_layered(GLenum target);
200
201 extern GLuint
202 _mesa_get_texture_layers(const struct gl_texture_object *texObj, GLint level);
203
204 extern GLsizei
205 _mesa_get_tex_max_num_levels(GLenum target, GLsizei width, GLsizei height,
206 GLsizei depth);
207
208 extern GLboolean
209 _mesa_legal_texture_dimensions(struct gl_context *ctx, GLenum target,
210 GLint level, GLint width, GLint height,
211 GLint depth, GLint border);
212
213 extern mesa_format
214 _mesa_validate_texbuffer_format(const struct gl_context *ctx,
215 GLenum internalFormat);
216
217
218 bool
219 _mesa_legal_texture_base_format_for_target(struct gl_context *ctx,
220 GLenum target,
221 GLenum internalFormat);
222
223 bool
224 _mesa_format_no_online_compression(GLenum format);
225
226 GLboolean
227 _mesa_is_renderable_texture_format(const struct gl_context *ctx,
228 GLenum internalformat);
229
230 extern void
231 _mesa_texture_sub_image(struct gl_context *ctx, GLuint dims,
232 struct gl_texture_object *texObj,
233 struct gl_texture_image *texImage,
234 GLenum target, GLint level,
235 GLint xoffset, GLint yoffset, GLint zoffset,
236 GLsizei width, GLsizei height, GLsizei depth,
237 GLenum format, GLenum type, const GLvoid *pixels,
238 bool dsa);
239
240 extern void
241 _mesa_texture_storage_ms_memory(struct gl_context *ctx, GLuint dims,
242 struct gl_texture_object *texObj,
243 struct gl_memory_object *memObj,
244 GLenum target, GLsizei samples,
245 GLenum internalFormat, GLsizei width,
246 GLsizei height, GLsizei depth,
247 GLboolean fixedSampleLocations,
248 GLuint64 offset, const char* func);
249
250 bool
251 _mesa_is_cube_map_texture(GLenum target);
252
253 GLboolean
254 _mesa_sparse_texture_error_check(struct gl_context *ctx, GLuint dims,
255 struct gl_texture_object *texObj,
256 mesa_format format, GLenum target, GLsizei levels,
257 GLsizei width, GLsizei height, GLsizei depth,
258 const char *func);
259
260 /*@}*/
261
262 #ifdef __cplusplus
263 }
264 #endif
265
266 #endif
267