xref: /aosp_15_r20/external/mesa3d/src/mesa/main/shaderimage.h (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1 /*
2  * Copyright 2013 Intel Corporation
3  *
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:
10  *
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
13  * Software.
14  *
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.
22  *
23  * Authors:
24  *    Francisco Jerez <[email protected]>
25  */
26 
27 #ifndef SHADERIMAGE_H
28 #define SHADERIMAGE_H
29 
30 #include "util/glheader.h"
31 #include "formats.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 struct gl_context;
38 
39 /**
40  * Get the matching mesa_format for a shader image format GL enum.
41  */
42 mesa_format
43 _mesa_get_shader_image_format(GLenum format);
44 
45 /**
46  * Get the pixel type GL enum from the shader image format GL enum.
47  */
48 GLenum
49 _mesa_get_shader_image_pixel_type(GLenum image_format);
50 
51 /**
52  * Get the GL image format class for a shader image format GL enum
53  */
54 GLenum
55 _mesa_get_image_format_class(GLenum format);
56 
57 /**
58  * Return whether an image format should be supported based on the current API
59  * version of the context.
60  */
61 bool
62 _mesa_is_shader_image_format_supported(const struct gl_context *ctx,
63                                        GLenum format);
64 
65 /**
66  * Get a single image unit struct with the default state.
67  */
68 struct gl_image_unit
69 _mesa_default_image_unit(struct gl_context *ctx);
70 
71 /**
72  * Initialize a context's shader image units to the default state.
73  */
74 void
75 _mesa_init_image_units(struct gl_context *ctx);
76 
77 void
78 _mesa_free_image_textures(struct gl_context *ctx);
79 
80 /**
81  * Return GL_TRUE if the state of the image unit passed as argument is valid
82  * and access from the shader is allowed.  Otherwise loads from this unit
83  * should return zero and stores should have no effect.
84  *
85  * The result depends on context state other than the passed image unit, part
86  * of the _NEW_TEXTURE_OBJECT set.
87  */
88 GLboolean
89 _mesa_is_image_unit_valid(struct gl_context *ctx, struct gl_image_unit *u);
90 
91 #ifdef __cplusplus
92 }
93 #endif
94 
95 #endif
96