2 * Mesa 3-D graphics library
4 * Copyright (C) 2013 Timothy Arceri All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
27 #include "bufferobj.h"
32 #include "objectlabel.h"
33 #include "pipelineobj.h"
35 #include "samplerobj.h"
36 #include "shaderobj.h"
39 #include "transformfeedback.h"
43 * Helper for _mesa_ObjectLabel() and _mesa_ObjectPtrLabel().
46 set_label(struct gl_context *ctx, char **labelPtr, const char *label,
47 int length, const char *caller)
52 /* set new label string */
55 if (length >= MAX_LABEL_LENGTH)
56 _mesa_error(ctx, GL_INVALID_VALUE,
57 "%s(length=%d, which is not less than "
58 "GL_MAX_LABEL_LENGTH=%d)", caller, length,
62 *labelPtr = malloc(length+1);
64 memcpy(*labelPtr, label, length);
65 /* length is not required to include the null terminator so
66 * add one just in case
68 (*labelPtr)[length] = '\0';
72 int len = strlen(label);
73 if (len >= MAX_LABEL_LENGTH)
74 _mesa_error(ctx, GL_INVALID_VALUE,
75 "%s(label length=%d, which is not less than "
76 "GL_MAX_LABEL_LENGTH=%d)", caller, len,
79 /* null-terminated string */
80 *labelPtr = strdup(label);
86 * Helper for _mesa_GetObjectLabel() and _mesa_GetObjectPtrLabel().
87 * \param src the src label (may be null)
88 * \param dst pointer to dest buffer (may be null)
89 * \param length returns length of label (may be null)
90 * \param bufsize size of dst buffer
93 copy_label(const GLchar *src, GLchar *dst, GLsizei *length, GLsizei bufSize)
97 /* From http://www.opengl.org/registry/specs/KHR/debug.txt:
98 * "If <length> is NULL, no length is returned. The maximum number of
99 * characters that may be written into <label>, including the null
100 * terminator, is specified by <bufSize>. If no debug label was specified
101 * for the object then <label> will contain a null-terminated empty string,
102 * and zero will be returned in <length>. If <label> is NULL and <length>
103 * is non-NULL then no string will be returned and the length of the label
104 * will be returned in <length>."
108 labelLen = strlen(src);
112 if (bufSize <= labelLen)
113 labelLen = bufSize - 1;
115 memcpy(dst, src, labelLen);
118 dst[labelLen] = '\0';
126 * Helper for _mesa_ObjectLabel() and _mesa_GetObjectLabel().
129 get_label_pointer(struct gl_context *ctx, GLenum identifier, GLuint name,
132 char **labelPtr = NULL;
134 switch (identifier) {
137 struct gl_buffer_object *bufObj = _mesa_lookup_bufferobj(ctx, name);
139 labelPtr = &bufObj->Label;
144 struct gl_shader *shader = _mesa_lookup_shader(ctx, name);
146 labelPtr = &shader->Label;
151 struct gl_shader_program *program =
152 _mesa_lookup_shader_program(ctx, name);
154 labelPtr = &program->Label;
157 case GL_VERTEX_ARRAY:
159 struct gl_vertex_array_object *obj = _mesa_lookup_vao(ctx, name);
161 labelPtr = &obj->Label;
166 struct gl_query_object *query = _mesa_lookup_query_object(ctx, name);
168 labelPtr = &query->Label;
171 case GL_TRANSFORM_FEEDBACK:
173 struct gl_transform_feedback_object *tfo =
174 _mesa_lookup_transform_feedback_object(ctx, name);
176 labelPtr = &tfo->Label;
181 struct gl_sampler_object *so = _mesa_lookup_samplerobj(ctx, name);
183 labelPtr = &so->Label;
188 struct gl_texture_object *texObj = _mesa_lookup_texture(ctx, name);
190 labelPtr = &texObj->Label;
193 case GL_RENDERBUFFER:
195 struct gl_renderbuffer *rb = _mesa_lookup_renderbuffer(ctx, name);
197 labelPtr = &rb->Label;
202 struct gl_framebuffer *rb = _mesa_lookup_framebuffer(ctx, name);
204 labelPtr = &rb->Label;
207 case GL_DISPLAY_LIST:
208 if (ctx->API == API_OPENGL_COMPAT) {
209 struct gl_display_list *list = _mesa_lookup_list(ctx, name);
211 labelPtr = &list->Label;
217 case GL_PROGRAM_PIPELINE:
219 struct gl_pipeline_object *pipe =
220 _mesa_lookup_pipeline_object(ctx, name);
222 labelPtr = &pipe->Label;
229 if (NULL == labelPtr) {
230 _mesa_error(ctx, GL_INVALID_VALUE, "%s(name = %u)", caller, name);
236 _mesa_error(ctx, GL_INVALID_ENUM, "%s(identifier = %s)",
237 caller, _mesa_enum_to_string(identifier));
242 _mesa_ObjectLabel(GLenum identifier, GLuint name, GLsizei length,
245 GET_CURRENT_CONTEXT(ctx);
248 labelPtr = get_label_pointer(ctx, identifier, name, "glObjectLabel");
252 set_label(ctx, labelPtr, label, length, "glObjectLabel");
256 _mesa_GetObjectLabel(GLenum identifier, GLuint name, GLsizei bufSize,
257 GLsizei *length, GLchar *label)
259 GET_CURRENT_CONTEXT(ctx);
263 _mesa_error(ctx, GL_INVALID_VALUE, "glGetObjectLabel(bufSize = %d)",
268 labelPtr = get_label_pointer(ctx, identifier, name, "glGetObjectLabel");
272 copy_label(*labelPtr, label, length, bufSize);
276 _mesa_ObjectPtrLabel(const void *ptr, GLsizei length, const GLchar *label)
278 GET_CURRENT_CONTEXT(ctx);
280 struct gl_sync_object *const syncObj = (struct gl_sync_object *) ptr;
282 if (!_mesa_validate_sync(ctx, syncObj)) {
283 _mesa_error(ctx, GL_INVALID_VALUE, "glObjectPtrLabel (not a valid sync object)");
287 labelPtr = &syncObj->Label;
289 set_label(ctx, labelPtr, label, length, "glObjectPtrLabel");
293 _mesa_GetObjectPtrLabel(const void *ptr, GLsizei bufSize, GLsizei *length,
296 GET_CURRENT_CONTEXT(ctx);
298 struct gl_sync_object *const syncObj = (struct gl_sync_object *) ptr;
301 _mesa_error(ctx, GL_INVALID_VALUE, "glGetObjectPtrLabel(bufSize = %d)",
306 if (!_mesa_validate_sync(ctx, syncObj)) {
307 _mesa_error(ctx, GL_INVALID_VALUE, "glGetObjectPtrLabel (not a valid sync object)");
311 labelPtr = &syncObj->Label;
313 copy_label(*labelPtr, label, length, bufSize);