2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2007 Brian Paul 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.
28 * glClearColor, glClearIndex, glClear() functions.
45 _mesa_ClearIndex( GLfloat c
)
47 GET_CURRENT_CONTEXT(ctx
);
49 ctx
->Color
.ClearIndex
= (GLuint
) c
;
54 * Specify the clear values for the color buffers.
56 * \param red red color component.
57 * \param green green color component.
58 * \param blue blue color component.
59 * \param alpha alpha component.
63 * Clamps the parameters and updates gl_colorbuffer_attrib::ClearColor. On a
64 * change, flushes the vertices and notifies the driver via the
65 * dd_function_table::ClearColor callback.
68 _mesa_ClearColor( GLclampf red
, GLclampf green
, GLclampf blue
, GLclampf alpha
)
70 GET_CURRENT_CONTEXT(ctx
);
72 ctx
->Color
.ClearColor
.f
[0] = red
;
73 ctx
->Color
.ClearColor
.f
[1] = green
;
74 ctx
->Color
.ClearColor
.f
[2] = blue
;
75 ctx
->Color
.ClearColor
.f
[3] = alpha
;
80 * GL_EXT_texture_integer
83 _mesa_ClearColorIiEXT(GLint r
, GLint g
, GLint b
, GLint a
)
85 GET_CURRENT_CONTEXT(ctx
);
87 ctx
->Color
.ClearColor
.i
[0] = r
;
88 ctx
->Color
.ClearColor
.i
[1] = g
;
89 ctx
->Color
.ClearColor
.i
[2] = b
;
90 ctx
->Color
.ClearColor
.i
[3] = a
;
95 * GL_EXT_texture_integer
98 _mesa_ClearColorIuiEXT(GLuint r
, GLuint g
, GLuint b
, GLuint a
)
100 GET_CURRENT_CONTEXT(ctx
);
102 ctx
->Color
.ClearColor
.ui
[0] = r
;
103 ctx
->Color
.ClearColor
.ui
[1] = g
;
104 ctx
->Color
.ClearColor
.ui
[2] = b
;
105 ctx
->Color
.ClearColor
.ui
[3] = a
;
112 * \param mask bit-mask indicating the buffers to be cleared.
114 * Flushes the vertices and verifies the parameter. If __struct gl_contextRec::NewState
115 * is set then calls _mesa_update_state() to update gl_frame_buffer::_Xmin,
116 * etc. If the rasterization mode is set to GL_RENDER then requests the driver
117 * to clear the buffers, via the dd_function_table::Clear callback.
120 _mesa_Clear( GLbitfield mask
)
122 GET_CURRENT_CONTEXT(ctx
);
123 FLUSH_VERTICES(ctx
, 0);
125 FLUSH_CURRENT(ctx
, 0);
127 if (MESA_VERBOSE
& VERBOSE_API
)
128 _mesa_debug(ctx
, "glClear 0x%x\n", mask
);
130 if (mask
& ~(GL_COLOR_BUFFER_BIT
|
131 GL_DEPTH_BUFFER_BIT
|
132 GL_STENCIL_BUFFER_BIT
|
133 GL_ACCUM_BUFFER_BIT
)) {
134 /* invalid bit set */
135 _mesa_error( ctx
, GL_INVALID_VALUE
, "glClear(0x%x)", mask
);
139 /* Accumulation buffers were removed in core contexts, and they never
140 * existed in OpenGL ES.
142 if ((mask
& GL_ACCUM_BUFFER_BIT
) != 0
143 && (ctx
->API
== API_OPENGL_CORE
|| _mesa_is_gles(ctx
))) {
144 _mesa_error( ctx
, GL_INVALID_VALUE
, "glClear(GL_ACCUM_BUFFER_BIT)");
149 _mesa_update_state( ctx
); /* update _Xmin, etc */
152 if (ctx
->DrawBuffer
->_Status
!= GL_FRAMEBUFFER_COMPLETE_EXT
) {
153 _mesa_error(ctx
, GL_INVALID_FRAMEBUFFER_OPERATION_EXT
,
154 "glClear(incomplete framebuffer)");
158 if (ctx
->DrawBuffer
->Width
== 0 || ctx
->DrawBuffer
->Height
== 0 ||
159 ctx
->DrawBuffer
->_Xmin
>= ctx
->DrawBuffer
->_Xmax
||
160 ctx
->DrawBuffer
->_Ymin
>= ctx
->DrawBuffer
->_Ymax
)
163 if (ctx
->RasterDiscard
)
166 if (ctx
->RenderMode
== GL_RENDER
) {
167 GLbitfield bufferMask
;
169 /* don't clear depth buffer if depth writing disabled */
170 if (!ctx
->Depth
.Mask
)
171 mask
&= ~GL_DEPTH_BUFFER_BIT
;
173 /* Build the bitmask to send to device driver's Clear function.
174 * Note that the GL_COLOR_BUFFER_BIT flag will expand to 0, 1, 2 or 4
175 * of the BUFFER_BIT_FRONT/BACK_LEFT/RIGHT flags, or one of the
176 * BUFFER_BIT_COLORn flags.
179 if (mask
& GL_COLOR_BUFFER_BIT
) {
181 for (i
= 0; i
< ctx
->DrawBuffer
->_NumColorDrawBuffers
; i
++) {
182 bufferMask
|= (1 << ctx
->DrawBuffer
->_ColorDrawBufferIndexes
[i
]);
186 if ((mask
& GL_DEPTH_BUFFER_BIT
)
187 && ctx
->DrawBuffer
->Visual
.haveDepthBuffer
) {
188 bufferMask
|= BUFFER_BIT_DEPTH
;
191 if ((mask
& GL_STENCIL_BUFFER_BIT
)
192 && ctx
->DrawBuffer
->Visual
.haveStencilBuffer
) {
193 bufferMask
|= BUFFER_BIT_STENCIL
;
196 if ((mask
& GL_ACCUM_BUFFER_BIT
)
197 && ctx
->DrawBuffer
->Visual
.haveAccumBuffer
) {
198 bufferMask
|= BUFFER_BIT_ACCUM
;
201 ASSERT(ctx
->Driver
.Clear
);
202 ctx
->Driver
.Clear(ctx
, bufferMask
);
207 /** Returned by make_color_buffer_mask() for errors */
208 #define INVALID_MASK ~0x0
212 * Convert the glClearBuffer 'drawbuffer' parameter into a bitmask of
213 * BUFFER_BIT_x values.
214 * Return INVALID_MASK if the drawbuffer value is invalid.
217 make_color_buffer_mask(struct gl_context
*ctx
, GLint drawbuffer
)
219 const struct gl_renderbuffer_attachment
*att
= ctx
->DrawBuffer
->Attachment
;
220 GLbitfield mask
= 0x0;
222 switch (drawbuffer
) {
224 if (att
[BUFFER_FRONT_LEFT
].Renderbuffer
)
225 mask
|= BUFFER_BIT_FRONT_LEFT
;
226 if (att
[BUFFER_FRONT_RIGHT
].Renderbuffer
)
227 mask
|= BUFFER_BIT_FRONT_RIGHT
;
230 if (att
[BUFFER_BACK_LEFT
].Renderbuffer
)
231 mask
|= BUFFER_BIT_BACK_LEFT
;
232 if (att
[BUFFER_BACK_RIGHT
].Renderbuffer
)
233 mask
|= BUFFER_BIT_BACK_RIGHT
;
236 if (att
[BUFFER_FRONT_LEFT
].Renderbuffer
)
237 mask
|= BUFFER_BIT_FRONT_LEFT
;
238 if (att
[BUFFER_BACK_LEFT
].Renderbuffer
)
239 mask
|= BUFFER_BIT_BACK_LEFT
;
242 if (att
[BUFFER_FRONT_RIGHT
].Renderbuffer
)
243 mask
|= BUFFER_BIT_FRONT_RIGHT
;
244 if (att
[BUFFER_BACK_RIGHT
].Renderbuffer
)
245 mask
|= BUFFER_BIT_BACK_RIGHT
;
247 case GL_FRONT_AND_BACK
:
248 if (att
[BUFFER_FRONT_LEFT
].Renderbuffer
)
249 mask
|= BUFFER_BIT_FRONT_LEFT
;
250 if (att
[BUFFER_BACK_LEFT
].Renderbuffer
)
251 mask
|= BUFFER_BIT_BACK_LEFT
;
252 if (att
[BUFFER_FRONT_RIGHT
].Renderbuffer
)
253 mask
|= BUFFER_BIT_FRONT_RIGHT
;
254 if (att
[BUFFER_BACK_RIGHT
].Renderbuffer
)
255 mask
|= BUFFER_BIT_BACK_RIGHT
;
258 if (drawbuffer
< 0 || drawbuffer
>= (GLint
)ctx
->Const
.MaxDrawBuffers
) {
261 else if (att
[BUFFER_COLOR0
+ drawbuffer
].Renderbuffer
) {
262 mask
|= (BUFFER_BIT_COLOR0
<< drawbuffer
);
273 * Clear signed integer color buffer or stencil buffer (not depth).
276 _mesa_ClearBufferiv(GLenum buffer
, GLint drawbuffer
, const GLint
*value
)
278 GET_CURRENT_CONTEXT(ctx
);
279 FLUSH_VERTICES(ctx
, 0);
281 FLUSH_CURRENT(ctx
, 0);
284 _mesa_update_state( ctx
);
289 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
291 * "ClearBuffer generates an INVALID VALUE error if buffer is
292 * COLOR and drawbuffer is less than zero, or greater than the
293 * value of MAX DRAW BUFFERS minus one; or if buffer is DEPTH,
294 * STENCIL, or DEPTH STENCIL and drawbuffer is not zero."
296 if (drawbuffer
!= 0) {
297 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferiv(drawbuffer=%d)",
301 else if (ctx
->DrawBuffer
->Attachment
[BUFFER_STENCIL
].Renderbuffer
&& !ctx
->RasterDiscard
) {
302 /* Save current stencil clear value, set to 'value', do the
303 * stencil clear and restore the clear value.
304 * XXX in the future we may have a new ctx->Driver.ClearBuffer()
307 const GLuint clearSave
= ctx
->Stencil
.Clear
;
308 ctx
->Stencil
.Clear
= *value
;
309 ctx
->Driver
.Clear(ctx
, BUFFER_BIT_STENCIL
);
310 ctx
->Stencil
.Clear
= clearSave
;
315 const GLbitfield mask
= make_color_buffer_mask(ctx
, drawbuffer
);
316 if (mask
== INVALID_MASK
) {
317 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferiv(drawbuffer=%d)",
321 else if (mask
&& !ctx
->RasterDiscard
) {
322 union gl_color_union clearSave
;
325 clearSave
= ctx
->Color
.ClearColor
;
327 COPY_4V(ctx
->Color
.ClearColor
.i
, value
);
328 /* clear buffer(s) */
329 ctx
->Driver
.Clear(ctx
, mask
);
331 ctx
->Color
.ClearColor
= clearSave
;
336 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
338 * "The result of ClearBuffer is undefined if no conversion between
339 * the type of the specified value and the type of the buffer being
340 * cleared is defined (for example, if ClearBufferiv is called for a
341 * fixed- or floating-point buffer, or if ClearBufferfv is called
342 * for a signed or unsigned integer buffer). This is not an error."
344 * In this case we take "undefined" and "not an error" to mean "ignore."
345 * Note that we still need to generate an error for the invalid
346 * drawbuffer case (see the GL_STENCIL case above).
348 if (drawbuffer
!= 0) {
349 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferiv(drawbuffer=%d)",
355 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferiv(buffer=%s)",
356 _mesa_lookup_enum_by_nr(buffer
));
364 * Clear unsigned integer color buffer (not depth, not stencil).
367 _mesa_ClearBufferuiv(GLenum buffer
, GLint drawbuffer
, const GLuint
*value
)
369 GET_CURRENT_CONTEXT(ctx
);
371 FLUSH_VERTICES(ctx
, 0);
372 FLUSH_CURRENT(ctx
, 0);
375 _mesa_update_state( ctx
);
381 const GLbitfield mask
= make_color_buffer_mask(ctx
, drawbuffer
);
382 if (mask
== INVALID_MASK
) {
383 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferuiv(drawbuffer=%d)",
387 else if (mask
&& !ctx
->RasterDiscard
) {
388 union gl_color_union clearSave
;
391 clearSave
= ctx
->Color
.ClearColor
;
393 COPY_4V(ctx
->Color
.ClearColor
.ui
, value
);
394 /* clear buffer(s) */
395 ctx
->Driver
.Clear(ctx
, mask
);
397 ctx
->Color
.ClearColor
= clearSave
;
403 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
405 * "The result of ClearBuffer is undefined if no conversion between
406 * the type of the specified value and the type of the buffer being
407 * cleared is defined (for example, if ClearBufferiv is called for a
408 * fixed- or floating-point buffer, or if ClearBufferfv is called
409 * for a signed or unsigned integer buffer). This is not an error."
411 * In this case we take "undefined" and "not an error" to mean "ignore."
412 * Even though we could do something sensible for GL_STENCIL, page 263
413 * (page 279 of the PDF) says:
415 * "Only ClearBufferiv should be used to clear stencil buffers."
417 * Note that we still need to generate an error for the invalid
418 * drawbuffer case (see the GL_STENCIL case in _mesa_ClearBufferiv).
420 if (drawbuffer
!= 0) {
421 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferuiv(drawbuffer=%d)",
427 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferuiv(buffer=%s)",
428 _mesa_lookup_enum_by_nr(buffer
));
436 * Clear fixed-pt or float color buffer or depth buffer (not stencil).
439 _mesa_ClearBufferfv(GLenum buffer
, GLint drawbuffer
, const GLfloat
*value
)
441 GET_CURRENT_CONTEXT(ctx
);
443 FLUSH_VERTICES(ctx
, 0);
444 FLUSH_CURRENT(ctx
, 0);
447 _mesa_update_state( ctx
);
452 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
454 * "ClearBuffer generates an INVALID VALUE error if buffer is
455 * COLOR and drawbuffer is less than zero, or greater than the
456 * value of MAX DRAW BUFFERS minus one; or if buffer is DEPTH,
457 * STENCIL, or DEPTH STENCIL and drawbuffer is not zero."
459 if (drawbuffer
!= 0) {
460 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfv(drawbuffer=%d)",
464 else if (ctx
->DrawBuffer
->Attachment
[BUFFER_DEPTH
].Renderbuffer
&& !ctx
->RasterDiscard
) {
465 /* Save current depth clear value, set to 'value', do the
466 * depth clear and restore the clear value.
467 * XXX in the future we may have a new ctx->Driver.ClearBuffer()
470 const GLclampd clearSave
= ctx
->Depth
.Clear
;
471 ctx
->Depth
.Clear
= *value
;
472 ctx
->Driver
.Clear(ctx
, BUFFER_BIT_DEPTH
);
473 ctx
->Depth
.Clear
= clearSave
;
475 /* clear depth buffer to value */
479 const GLbitfield mask
= make_color_buffer_mask(ctx
, drawbuffer
);
480 if (mask
== INVALID_MASK
) {
481 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfv(drawbuffer=%d)",
485 else if (mask
&& !ctx
->RasterDiscard
) {
486 union gl_color_union clearSave
;
489 clearSave
= ctx
->Color
.ClearColor
;
491 COPY_4V(ctx
->Color
.ClearColor
.f
, value
);
492 /* clear buffer(s) */
493 ctx
->Driver
.Clear(ctx
, mask
);
495 ctx
->Color
.ClearColor
= clearSave
;
500 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
502 * "The result of ClearBuffer is undefined if no conversion between
503 * the type of the specified value and the type of the buffer being
504 * cleared is defined (for example, if ClearBufferiv is called for a
505 * fixed- or floating-point buffer, or if ClearBufferfv is called
506 * for a signed or unsigned integer buffer). This is not an error."
508 * In this case we take "undefined" and "not an error" to mean "ignore."
509 * Note that we still need to generate an error for the invalid
510 * drawbuffer case (see the GL_DEPTH case above).
512 if (drawbuffer
!= 0) {
513 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfv(drawbuffer=%d)",
519 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferfv(buffer=%s)",
520 _mesa_lookup_enum_by_nr(buffer
));
528 * Clear depth/stencil buffer only.
531 _mesa_ClearBufferfi(GLenum buffer
, GLint drawbuffer
,
532 GLfloat depth
, GLint stencil
)
534 GET_CURRENT_CONTEXT(ctx
);
537 FLUSH_VERTICES(ctx
, 0);
538 FLUSH_CURRENT(ctx
, 0);
540 if (buffer
!= GL_DEPTH_STENCIL
) {
541 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferfi(buffer=%s)",
542 _mesa_lookup_enum_by_nr(buffer
));
546 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
548 * "ClearBuffer generates an INVALID VALUE error if buffer is
549 * COLOR and drawbuffer is less than zero, or greater than the
550 * value of MAX DRAW BUFFERS minus one; or if buffer is DEPTH,
551 * STENCIL, or DEPTH STENCIL and drawbuffer is not zero."
553 if (drawbuffer
!= 0) {
554 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfi(drawbuffer=%d)",
559 if (ctx
->RasterDiscard
)
563 _mesa_update_state( ctx
);
566 if (ctx
->DrawBuffer
->Attachment
[BUFFER_DEPTH
].Renderbuffer
)
567 mask
|= BUFFER_BIT_DEPTH
;
568 if (ctx
->DrawBuffer
->Attachment
[BUFFER_STENCIL
].Renderbuffer
)
569 mask
|= BUFFER_BIT_STENCIL
;
572 /* save current clear values */
573 const GLclampd clearDepthSave
= ctx
->Depth
.Clear
;
574 const GLuint clearStencilSave
= ctx
->Stencil
.Clear
;
576 /* set new clear values */
577 ctx
->Depth
.Clear
= depth
;
578 ctx
->Stencil
.Clear
= stencil
;
581 ctx
->Driver
.Clear(ctx
, mask
);
584 ctx
->Depth
.Clear
= clearDepthSave
;
585 ctx
->Stencil
.Clear
= clearStencilSave
;