2 * Copyright 2013 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Francisco Jerez <currojerez@riseup.net>
29 #include "shaderimage.h"
39 * Define endian-invariant aliases for some mesa formats that are
40 * defined in terms of their channel layout from LSB to MSB in a
41 * 32-bit word. The actual byte offsets matter here because the user
42 * is allowed to bit-cast one format into another and get predictable
45 #ifdef MESA_BIG_ENDIAN
46 # define MESA_FORMAT_RGBA_8 MESA_FORMAT_A8B8G8R8_UNORM
47 # define MESA_FORMAT_RG_16 MESA_FORMAT_G16R16_UNORM
48 # define MESA_FORMAT_RG_8 MESA_FORMAT_G8R8_UNORM
49 # define MESA_FORMAT_SIGNED_RGBA_8 MESA_FORMAT_A8B8G8R8_SNORM
50 # define MESA_FORMAT_SIGNED_RG_16 MESA_FORMAT_G16R16_SNORM
51 # define MESA_FORMAT_SIGNED_RG_8 MESA_FORMAT_G8R8_SNORM
53 # define MESA_FORMAT_RGBA_8 MESA_FORMAT_R8G8B8A8_UNORM
54 # define MESA_FORMAT_RG_16 MESA_FORMAT_R16G16_UNORM
55 # define MESA_FORMAT_RG_8 MESA_FORMAT_R8G8_UNORM
56 # define MESA_FORMAT_SIGNED_RGBA_8 MESA_FORMAT_R8G8B8A8_SNORM
57 # define MESA_FORMAT_SIGNED_RG_16 MESA_FORMAT_R16G16_SNORM
58 # define MESA_FORMAT_SIGNED_RG_8 MESA_FORMAT_R8G8_SNORM
62 _mesa_get_shader_image_format(GLenum format
)
66 return MESA_FORMAT_RGBA_FLOAT32
;
69 return MESA_FORMAT_RGBA_FLOAT16
;
72 return MESA_FORMAT_RG_FLOAT32
;
75 return MESA_FORMAT_RG_FLOAT16
;
77 case GL_R11F_G11F_B10F
:
78 return MESA_FORMAT_R11G11B10_FLOAT
;
81 return MESA_FORMAT_R_FLOAT32
;
84 return MESA_FORMAT_R_FLOAT16
;
87 return MESA_FORMAT_RGBA_UINT32
;
90 return MESA_FORMAT_RGBA_UINT16
;
93 return MESA_FORMAT_R10G10B10A2_UINT
;
96 return MESA_FORMAT_RGBA_UINT8
;
99 return MESA_FORMAT_RG_UINT32
;
102 return MESA_FORMAT_RG_UINT16
;
105 return MESA_FORMAT_RG_UINT8
;
108 return MESA_FORMAT_R_UINT32
;
111 return MESA_FORMAT_R_UINT16
;
114 return MESA_FORMAT_R_UINT8
;
117 return MESA_FORMAT_RGBA_SINT32
;
120 return MESA_FORMAT_RGBA_SINT16
;
123 return MESA_FORMAT_RGBA_SINT8
;
126 return MESA_FORMAT_RG_SINT32
;
129 return MESA_FORMAT_RG_SINT16
;
132 return MESA_FORMAT_RG_SINT8
;
135 return MESA_FORMAT_R_SINT32
;
138 return MESA_FORMAT_R_SINT16
;
141 return MESA_FORMAT_R_SINT8
;
144 return MESA_FORMAT_RGBA_UNORM16
;
147 return MESA_FORMAT_R10G10B10A2_UNORM
;
150 return MESA_FORMAT_RGBA_8
;
153 return MESA_FORMAT_RG_16
;
156 return MESA_FORMAT_RG_8
;
159 return MESA_FORMAT_R_UNORM16
;
162 return MESA_FORMAT_R_UNORM8
;
164 case GL_RGBA16_SNORM
:
165 return MESA_FORMAT_RGBA_SNORM16
;
168 return MESA_FORMAT_SIGNED_RGBA_8
;
171 return MESA_FORMAT_SIGNED_RG_16
;
174 return MESA_FORMAT_SIGNED_RG_8
;
177 return MESA_FORMAT_R_SNORM16
;
180 return MESA_FORMAT_R_SNORM8
;
183 return MESA_FORMAT_NONE
;
187 enum image_format_class
189 /** Not a valid image format. */
190 IMAGE_FORMAT_CLASS_NONE
= 0,
192 /** Classes of image formats you can cast into each other. */
194 IMAGE_FORMAT_CLASS_1X8
,
195 IMAGE_FORMAT_CLASS_1X16
,
196 IMAGE_FORMAT_CLASS_1X32
,
197 IMAGE_FORMAT_CLASS_2X8
,
198 IMAGE_FORMAT_CLASS_2X16
,
199 IMAGE_FORMAT_CLASS_2X32
,
200 IMAGE_FORMAT_CLASS_10_11_11
,
201 IMAGE_FORMAT_CLASS_4X8
,
202 IMAGE_FORMAT_CLASS_4X16
,
203 IMAGE_FORMAT_CLASS_4X32
,
204 IMAGE_FORMAT_CLASS_2_10_10_10
208 static enum image_format_class
209 get_image_format_class(mesa_format format
)
212 case MESA_FORMAT_RGBA_FLOAT32
:
213 return IMAGE_FORMAT_CLASS_4X32
;
215 case MESA_FORMAT_RGBA_FLOAT16
:
216 return IMAGE_FORMAT_CLASS_4X16
;
218 case MESA_FORMAT_RG_FLOAT32
:
219 return IMAGE_FORMAT_CLASS_2X32
;
221 case MESA_FORMAT_RG_FLOAT16
:
222 return IMAGE_FORMAT_CLASS_2X16
;
224 case MESA_FORMAT_R11G11B10_FLOAT
:
225 return IMAGE_FORMAT_CLASS_10_11_11
;
227 case MESA_FORMAT_R_FLOAT32
:
228 return IMAGE_FORMAT_CLASS_1X32
;
230 case MESA_FORMAT_R_FLOAT16
:
231 return IMAGE_FORMAT_CLASS_1X16
;
233 case MESA_FORMAT_RGBA_UINT32
:
234 return IMAGE_FORMAT_CLASS_4X32
;
236 case MESA_FORMAT_RGBA_UINT16
:
237 return IMAGE_FORMAT_CLASS_4X16
;
239 case MESA_FORMAT_R10G10B10A2_UINT
:
240 return IMAGE_FORMAT_CLASS_2_10_10_10
;
242 case MESA_FORMAT_RGBA_UINT8
:
243 return IMAGE_FORMAT_CLASS_4X8
;
245 case MESA_FORMAT_RG_UINT32
:
246 return IMAGE_FORMAT_CLASS_2X32
;
248 case MESA_FORMAT_RG_UINT16
:
249 return IMAGE_FORMAT_CLASS_2X16
;
251 case MESA_FORMAT_RG_UINT8
:
252 return IMAGE_FORMAT_CLASS_2X8
;
254 case MESA_FORMAT_R_UINT32
:
255 return IMAGE_FORMAT_CLASS_1X32
;
257 case MESA_FORMAT_R_UINT16
:
258 return IMAGE_FORMAT_CLASS_1X16
;
260 case MESA_FORMAT_R_UINT8
:
261 return IMAGE_FORMAT_CLASS_1X8
;
263 case MESA_FORMAT_RGBA_SINT32
:
264 return IMAGE_FORMAT_CLASS_4X32
;
266 case MESA_FORMAT_RGBA_SINT16
:
267 return IMAGE_FORMAT_CLASS_4X16
;
269 case MESA_FORMAT_RGBA_SINT8
:
270 return IMAGE_FORMAT_CLASS_4X8
;
272 case MESA_FORMAT_RG_SINT32
:
273 return IMAGE_FORMAT_CLASS_2X32
;
275 case MESA_FORMAT_RG_SINT16
:
276 return IMAGE_FORMAT_CLASS_2X16
;
278 case MESA_FORMAT_RG_SINT8
:
279 return IMAGE_FORMAT_CLASS_2X8
;
281 case MESA_FORMAT_R_SINT32
:
282 return IMAGE_FORMAT_CLASS_1X32
;
284 case MESA_FORMAT_R_SINT16
:
285 return IMAGE_FORMAT_CLASS_1X16
;
287 case MESA_FORMAT_R_SINT8
:
288 return IMAGE_FORMAT_CLASS_1X8
;
290 case MESA_FORMAT_RGBA_UNORM16
:
291 return IMAGE_FORMAT_CLASS_4X16
;
293 case MESA_FORMAT_R10G10B10A2_UNORM
:
294 return IMAGE_FORMAT_CLASS_2_10_10_10
;
296 case MESA_FORMAT_RGBA_8
:
297 return IMAGE_FORMAT_CLASS_4X8
;
299 case MESA_FORMAT_RG_16
:
300 return IMAGE_FORMAT_CLASS_2X16
;
302 case MESA_FORMAT_RG_8
:
303 return IMAGE_FORMAT_CLASS_2X8
;
305 case MESA_FORMAT_R_UNORM16
:
306 return IMAGE_FORMAT_CLASS_1X16
;
308 case MESA_FORMAT_R_UNORM8
:
309 return IMAGE_FORMAT_CLASS_1X8
;
311 case MESA_FORMAT_RGBA_SNORM16
:
312 return IMAGE_FORMAT_CLASS_4X16
;
314 case MESA_FORMAT_SIGNED_RGBA_8
:
315 return IMAGE_FORMAT_CLASS_4X8
;
317 case MESA_FORMAT_SIGNED_RG_16
:
318 return IMAGE_FORMAT_CLASS_2X16
;
320 case MESA_FORMAT_SIGNED_RG_8
:
321 return IMAGE_FORMAT_CLASS_2X8
;
323 case MESA_FORMAT_R_SNORM16
:
324 return IMAGE_FORMAT_CLASS_1X16
;
326 case MESA_FORMAT_R_SNORM8
:
327 return IMAGE_FORMAT_CLASS_1X8
;
330 return IMAGE_FORMAT_CLASS_NONE
;
335 _image_format_class_to_glenum(enum image_format_class
class)
338 case IMAGE_FORMAT_CLASS_NONE
:
340 case IMAGE_FORMAT_CLASS_1X8
:
341 return GL_IMAGE_CLASS_1_X_8
;
342 case IMAGE_FORMAT_CLASS_1X16
:
343 return GL_IMAGE_CLASS_1_X_16
;
344 case IMAGE_FORMAT_CLASS_1X32
:
345 return GL_IMAGE_CLASS_1_X_32
;
346 case IMAGE_FORMAT_CLASS_2X8
:
347 return GL_IMAGE_CLASS_2_X_8
;
348 case IMAGE_FORMAT_CLASS_2X16
:
349 return GL_IMAGE_CLASS_2_X_16
;
350 case IMAGE_FORMAT_CLASS_2X32
:
351 return GL_IMAGE_CLASS_2_X_32
;
352 case IMAGE_FORMAT_CLASS_10_11_11
:
353 return GL_IMAGE_CLASS_11_11_10
;
354 case IMAGE_FORMAT_CLASS_4X8
:
355 return GL_IMAGE_CLASS_4_X_8
;
356 case IMAGE_FORMAT_CLASS_4X16
:
357 return GL_IMAGE_CLASS_4_X_16
;
358 case IMAGE_FORMAT_CLASS_4X32
:
359 return GL_IMAGE_CLASS_4_X_32
;
360 case IMAGE_FORMAT_CLASS_2_10_10_10
:
361 return GL_IMAGE_CLASS_10_10_10_2
;
363 assert(!"Invalid image_format_class");
369 _mesa_get_image_format_class(GLenum format
)
371 mesa_format tex_format
= _mesa_get_shader_image_format(format
);
372 if (tex_format
== MESA_FORMAT_NONE
)
375 enum image_format_class
class = get_image_format_class(tex_format
);
376 return _image_format_class_to_glenum(class);
380 _mesa_is_shader_image_format_supported(const struct gl_context
*ctx
,
384 /* Formats supported on both desktop and ES GL, c.f. table 8.27 of the
385 * OpenGL ES 3.1 specification.
402 /* Formats supported on unextended desktop GL and the original
403 * ARB_shader_image_load_store extension, c.f. table 3.21 of the OpenGL 4.2
404 * specification or by GLES 3.1 with GL_NV_image_formats extension.
408 case GL_R11F_G11F_B10F
:
428 /* Formats supported on unextended desktop GL and the original
429 * ARB_shader_image_load_store extension, c.f. table 3.21 of the OpenGL 4.2
432 * These can be supported by GLES 3.1 with GL_NV_image_formats &
433 * GL_EXT_texture_norm16 extensions but we don't have support for the
434 * latter in Mesa yet.
437 case GL_RGBA16_SNORM
:
442 return _mesa_is_desktop_gl(ctx
);
450 _mesa_default_image_unit(struct gl_context
*ctx
)
452 const GLenum format
= _mesa_is_desktop_gl(ctx
) ? GL_R8
: GL_R32UI
;
453 const struct gl_image_unit u
= {
454 .Access
= GL_READ_ONLY
,
456 ._ActualFormat
= _mesa_get_shader_image_format(format
)
462 _mesa_init_image_units(struct gl_context
*ctx
)
466 for (i
= 0; i
< ARRAY_SIZE(ctx
->ImageUnits
); ++i
)
467 ctx
->ImageUnits
[i
] = _mesa_default_image_unit(ctx
);
471 _mesa_is_image_unit_valid(struct gl_context
*ctx
, struct gl_image_unit
*u
)
473 struct gl_texture_object
*t
= u
->TexObj
;
474 mesa_format tex_format
;
479 if (!t
->_BaseComplete
&& !t
->_MipmapComplete
)
480 _mesa_test_texobj_completeness(ctx
, t
);
482 if (u
->Level
< t
->BaseLevel
||
483 u
->Level
> t
->_MaxLevel
||
484 (u
->Level
== t
->BaseLevel
&& !t
->_BaseComplete
) ||
485 (u
->Level
!= t
->BaseLevel
&& !t
->_MipmapComplete
))
488 if (_mesa_tex_target_is_layered(t
->Target
) &&
489 u
->_Layer
>= _mesa_get_texture_layers(t
, u
->Level
))
492 if (t
->Target
== GL_TEXTURE_BUFFER
) {
493 tex_format
= _mesa_get_shader_image_format(t
->BufferObjectFormat
);
496 struct gl_texture_image
*img
= (t
->Target
== GL_TEXTURE_CUBE_MAP
?
497 t
->Image
[u
->_Layer
][u
->Level
] :
498 t
->Image
[0][u
->Level
]);
500 if (!img
|| img
->Border
|| img
->NumSamples
> ctx
->Const
.MaxImageSamples
)
503 tex_format
= _mesa_get_shader_image_format(img
->InternalFormat
);
509 switch (t
->ImageFormatCompatibilityType
) {
510 case GL_IMAGE_FORMAT_COMPATIBILITY_BY_SIZE
:
511 if (_mesa_get_format_bytes(tex_format
) !=
512 _mesa_get_format_bytes(u
->_ActualFormat
))
516 case GL_IMAGE_FORMAT_COMPATIBILITY_BY_CLASS
:
517 if (get_image_format_class(tex_format
) !=
518 get_image_format_class(u
->_ActualFormat
))
523 assert(!"Unexpected image format compatibility type");
530 validate_bind_image_texture(struct gl_context
*ctx
, GLuint unit
,
531 GLuint texture
, GLint level
, GLboolean layered
,
532 GLint layer
, GLenum access
, GLenum format
)
534 assert(ctx
->Const
.MaxImageUnits
<= MAX_IMAGE_UNITS
);
536 if (unit
>= ctx
->Const
.MaxImageUnits
) {
537 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindImageTexture(unit)");
542 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindImageTexture(level)");
547 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindImageTexture(layer)");
551 if (access
!= GL_READ_ONLY
&&
552 access
!= GL_WRITE_ONLY
&&
553 access
!= GL_READ_WRITE
) {
554 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindImageTexture(access)");
558 if (!_mesa_is_shader_image_format_supported(ctx
, format
)) {
559 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindImageTexture(format)");
567 _mesa_BindImageTexture(GLuint unit
, GLuint texture
, GLint level
,
568 GLboolean layered
, GLint layer
, GLenum access
,
571 GET_CURRENT_CONTEXT(ctx
);
572 struct gl_image_unit
*u
;
574 if (!validate_bind_image_texture(ctx
, unit
, texture
, level
,
575 layered
, layer
, access
, format
))
578 u
= &ctx
->ImageUnits
[unit
];
580 FLUSH_VERTICES(ctx
, 0);
581 ctx
->NewDriverState
|= ctx
->DriverFlags
.NewImageUnits
;
584 struct gl_texture_object
*t
= _mesa_lookup_texture(ctx
, texture
);
587 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindImageTexture(texture)");
591 /* From section 8.22 "Texture Image Loads and Stores" of the OpenGL ES
594 * "An INVALID_OPERATION error is generated if texture is not the name
595 * of an immutable texture object."
597 * However note that issue 7 of the GL_OES_texture_buffer spec
598 * recognizes that there is no way to create immutable buffer textures,
599 * so those are excluded from this requirement.
601 if (_mesa_is_gles(ctx
) && !t
->Immutable
&&
602 t
->Target
!= GL_TEXTURE_BUFFER
) {
603 _mesa_error(ctx
, GL_INVALID_OPERATION
,
604 "glBindImageTexture(!immutable)");
608 _mesa_reference_texobj(&u
->TexObj
, t
);
610 _mesa_reference_texobj(&u
->TexObj
, NULL
);
616 u
->_ActualFormat
= _mesa_get_shader_image_format(format
);
618 if (u
->TexObj
&& _mesa_tex_target_is_layered(u
->TexObj
->Target
)) {
619 u
->Layered
= layered
;
621 u
->_Layer
= (u
->Layered
? 0 : u
->Layer
);
623 u
->Layered
= GL_FALSE
;
629 _mesa_BindImageTextures(GLuint first
, GLsizei count
, const GLuint
*textures
)
631 GET_CURRENT_CONTEXT(ctx
);
634 if (!ctx
->Extensions
.ARB_shader_image_load_store
) {
635 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glBindImageTextures()");
639 if (first
+ count
> ctx
->Const
.MaxImageUnits
) {
640 /* The ARB_multi_bind spec says:
642 * "An INVALID_OPERATION error is generated if <first> + <count>
643 * is greater than the number of image units supported by
644 * the implementation."
646 _mesa_error(ctx
, GL_INVALID_OPERATION
,
647 "glBindImageTextures(first=%u + count=%d > the value of "
648 "GL_MAX_IMAGE_UNITS=%u)",
649 first
, count
, ctx
->Const
.MaxImageUnits
);
653 /* Assume that at least one binding will be changed */
654 FLUSH_VERTICES(ctx
, 0);
655 ctx
->NewDriverState
|= ctx
->DriverFlags
.NewImageUnits
;
657 /* Note that the error semantics for multi-bind commands differ from
658 * those of other GL commands.
660 * The Issues section in the ARB_multi_bind spec says:
662 * "(11) Typically, OpenGL specifies that if an error is generated by
663 * a command, that command has no effect. This is somewhat
664 * unfortunate for multi-bind commands, because it would require
665 * a first pass to scan the entire list of bound objects for
666 * errors and then a second pass to actually perform the
667 * bindings. Should we have different error semantics?
669 * RESOLVED: Yes. In this specification, when the parameters for
670 * one of the <count> binding points are invalid, that binding
671 * point is not updated and an error will be generated. However,
672 * other binding points in the same command will be updated if
673 * their parameters are valid and no other error occurs."
676 _mesa_begin_texture_lookups(ctx
);
678 for (i
= 0; i
< count
; i
++) {
679 struct gl_image_unit
*u
= &ctx
->ImageUnits
[first
+ i
];
680 const GLuint texture
= textures
? textures
[i
] : 0;
683 struct gl_texture_object
*texObj
;
686 if (!u
->TexObj
|| u
->TexObj
->Name
!= texture
) {
687 texObj
= _mesa_lookup_texture_locked(ctx
, texture
);
689 /* The ARB_multi_bind spec says:
691 * "An INVALID_OPERATION error is generated if any value
692 * in <textures> is not zero or the name of an existing
693 * texture object (per binding)."
695 _mesa_error(ctx
, GL_INVALID_OPERATION
,
696 "glBindImageTextures(textures[%d]=%u "
697 "is not zero or the name of an existing texture "
698 "object)", i
, texture
);
705 if (texObj
->Target
== GL_TEXTURE_BUFFER
) {
706 tex_format
= texObj
->BufferObjectFormat
;
708 struct gl_texture_image
*image
= texObj
->Image
[0][0];
710 if (!image
|| image
->Width
== 0 || image
->Height
== 0 ||
712 /* The ARB_multi_bind spec says:
714 * "An INVALID_OPERATION error is generated if the width,
715 * height, or depth of the level zero texture image of
716 * any texture in <textures> is zero (per binding)."
718 _mesa_error(ctx
, GL_INVALID_OPERATION
,
719 "glBindImageTextures(the width, height or depth "
720 "of the level zero texture image of "
721 "textures[%d]=%u is zero)", i
, texture
);
725 tex_format
= image
->InternalFormat
;
728 if (!_mesa_is_shader_image_format_supported(ctx
, tex_format
)) {
729 /* The ARB_multi_bind spec says:
731 * "An INVALID_OPERATION error is generated if the internal
732 * format of the level zero texture image of any texture
733 * in <textures> is not found in table 8.33 (per binding)."
735 _mesa_error(ctx
, GL_INVALID_OPERATION
,
736 "glBindImageTextures(the internal format %s of "
737 "the level zero texture image of textures[%d]=%u "
739 _mesa_enum_to_string(tex_format
),
744 /* Update the texture binding */
745 _mesa_reference_texobj(&u
->TexObj
, texObj
);
747 u
->Layered
= _mesa_tex_target_is_layered(texObj
->Target
);
748 u
->_Layer
= u
->Layer
= 0;
749 u
->Access
= GL_READ_WRITE
;
750 u
->Format
= tex_format
;
751 u
->_ActualFormat
= _mesa_get_shader_image_format(tex_format
);
753 /* Unbind the texture from the unit */
754 _mesa_reference_texobj(&u
->TexObj
, NULL
);
756 u
->Layered
= GL_FALSE
;
757 u
->_Layer
= u
->Layer
= 0;
758 u
->Access
= GL_READ_ONLY
;
760 u
->_ActualFormat
= MESA_FORMAT_R_UNORM8
;
764 _mesa_end_texture_lookups(ctx
);