main: Added entry point for BindTextureUnit.
[mesa.git] / src / mesa / main / texstate.h
1 /**
2 * \file texstate.h
3 * Texture state management.
4 */
5
6 /*
7 * Mesa 3-D graphics library
8 *
9 * Copyright (C) 1999-2007 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 TEXSTATE_H
32 #define TEXSTATE_H
33
34
35 #include "compiler.h"
36 #include "enums.h"
37 #include "macros.h"
38 #include "mtypes.h"
39
40
41 static inline struct gl_texture_unit *
42 _mesa_get_tex_unit(struct gl_context *ctx, GLuint unit)
43 {
44 ASSERT(unit >= 0);
45 ASSERT(unit < Elements(ctx->Texture.Unit));
46 return &(ctx->Texture.Unit[unit]);
47 }
48
49 /**
50 * Return pointer to current texture unit.
51 * This the texture unit set by glActiveTexture(), not glClientActiveTexture().
52 */
53 static inline struct gl_texture_unit *
54 _mesa_get_current_tex_unit(struct gl_context *ctx)
55 {
56 return _mesa_get_tex_unit(ctx, ctx->Texture.CurrentUnit);
57 }
58
59 static inline GLuint
60 _mesa_max_tex_unit(struct gl_context *ctx)
61 {
62 /* See OpenGL spec for glActiveTexture: */
63 return MAX2(ctx->Const.MaxCombinedTextureImageUnits,
64 ctx->Const.MaxTextureCoordUnits);
65 }
66
67 static inline struct gl_texture_unit *
68 _mesa_get_tex_unit_err(struct gl_context *ctx, GLuint unit, const char *func)
69 {
70 if (unit < _mesa_max_tex_unit(ctx))
71 return _mesa_get_tex_unit(ctx, unit);
72
73 /* Note: This error is a precedent set by glBindTextures. From the GL 4.5
74 * specification (30.10.2014) Section 8.1 ("Texture Objects"):
75 *
76 * "An INVALID_OPERATION error is generated if first + count is greater
77 * than the number of texture image units supported by the
78 * implementation."
79 */
80 _mesa_error(ctx, GL_INVALID_OPERATION, "%s(unit=%s)", func,
81 _mesa_lookup_enum_by_nr(GL_TEXTURE0+unit));
82 return NULL;
83 }
84
85
86 extern void
87 _mesa_copy_texture_state( const struct gl_context *src, struct gl_context *dst );
88
89 extern void
90 _mesa_print_texunit_state( struct gl_context *ctx, GLuint unit );
91
92
93
94 /**
95 * \name Called from API
96 */
97 /*@{*/
98
99 extern void GLAPIENTRY
100 _mesa_ActiveTexture( GLenum target );
101
102 extern void GLAPIENTRY
103 _mesa_ClientActiveTexture( GLenum target );
104
105 /*@}*/
106
107
108 /**
109 * \name Initialization, state maintenance
110 */
111 /*@{*/
112
113 extern void
114 _mesa_update_texture( struct gl_context *ctx, GLuint new_state );
115
116 extern GLboolean
117 _mesa_init_texture( struct gl_context *ctx );
118
119 extern void
120 _mesa_free_texture_data( struct gl_context *ctx );
121
122 extern void
123 _mesa_update_default_objects_texture(struct gl_context *ctx);
124
125 /*@}*/
126
127 #endif