shaderimage.h revision b8e80941 
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 <currojerez@riseup.net>
25 */
26
27#ifndef SHADERIMAGE_H
28#define SHADERIMAGE_H
29
30#include "glheader.h"
31#include "formats.h"
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37struct gl_context;
38
39/**
40 * Get the matching mesa_format for a shader image format GL enum.
41 */
42mesa_format
43_mesa_get_shader_image_format(GLenum format);
44
45/**
46 * Get the GL image format class for a shader image format GL enum
47 */
48GLenum
49_mesa_get_image_format_class(GLenum format);
50
51/**
52 * Return whether an image format should be supported based on the current API
53 * version of the context.
54 */
55bool
56_mesa_is_shader_image_format_supported(const struct gl_context *ctx,
57                                       GLenum format);
58
59/**
60 * Get a single image unit struct with the default state.
61 */
62struct gl_image_unit
63_mesa_default_image_unit(struct gl_context *ctx);
64
65/**
66 * Initialize a context's shader image units to the default state.
67 */
68void
69_mesa_init_image_units(struct gl_context *ctx);
70
71void
72_mesa_free_image_textures(struct gl_context *ctx);
73
74/**
75 * Return GL_TRUE if the state of the image unit passed as argument is valid
76 * and access from the shader is allowed.  Otherwise loads from this unit
77 * should return zero and stores should have no effect.
78 *
79 * The result depends on context state other than the passed image unit, part
80 * of the _NEW_TEXTURE_OBJECT set.
81 */
82GLboolean
83_mesa_is_image_unit_valid(struct gl_context *ctx, struct gl_image_unit *u);
84
85void GLAPIENTRY
86_mesa_BindImageTexture_no_error(GLuint unit, GLuint texture, GLint level,
87                                GLboolean layered, GLint layer, GLenum access,
88                                GLenum format);
89
90void GLAPIENTRY
91_mesa_BindImageTexture(GLuint unit, GLuint texture, GLint level,
92                       GLboolean layered, GLint layer, GLenum access,
93                       GLenum format);
94
95void GLAPIENTRY
96_mesa_BindImageTextures_no_error(GLuint first, GLsizei count,
97                                 const GLuint *textures);
98
99void GLAPIENTRY
100_mesa_BindImageTextures(GLuint first, GLsizei count, const GLuint *textures);
101
102#ifdef __cplusplus
103}
104#endif
105
106#endif
107