2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 * glClearColor, glClearIndex, glClear() functions.
46 _mesa_ClearIndex( GLfloat c
)
48 GET_CURRENT_CONTEXT(ctx
);
49 ASSERT_OUTSIDE_BEGIN_END(ctx
);
51 if (ctx
->Color
.ClearIndex
== (GLuint
) c
)
54 FLUSH_VERTICES(ctx
, _NEW_COLOR
);
55 ctx
->Color
.ClearIndex
= (GLuint
) c
;
61 * Specify the clear values for the color buffers.
63 * \param red red color component.
64 * \param green green color component.
65 * \param blue blue color component.
66 * \param alpha alpha component.
70 * Clamps the parameters and updates gl_colorbuffer_attrib::ClearColor. On a
71 * change, flushes the vertices and notifies the driver via the
72 * dd_function_table::ClearColor callback.
75 _mesa_ClearColor( GLclampf red
, GLclampf green
, GLclampf blue
, GLclampf alpha
)
78 GET_CURRENT_CONTEXT(ctx
);
79 ASSERT_OUTSIDE_BEGIN_END(ctx
);
86 if (TEST_EQ_4V(tmp
, ctx
->Color
.ClearColor
.f
))
87 return; /* no change */
89 FLUSH_VERTICES(ctx
, _NEW_COLOR
);
90 COPY_4V(ctx
->Color
.ClearColor
.f
, tmp
);
95 * GL_EXT_texture_integer
98 _mesa_ClearColorIiEXT(GLint r
, GLint g
, GLint b
, GLint a
)
101 GET_CURRENT_CONTEXT(ctx
);
102 ASSERT_OUTSIDE_BEGIN_END(ctx
);
109 if (TEST_EQ_4V(tmp
, ctx
->Color
.ClearColor
.i
))
110 return; /* no change */
112 FLUSH_VERTICES(ctx
, _NEW_COLOR
);
113 COPY_4V(ctx
->Color
.ClearColor
.i
, tmp
);
118 * GL_EXT_texture_integer
121 _mesa_ClearColorIuiEXT(GLuint r
, GLuint g
, GLuint b
, GLuint a
)
124 GET_CURRENT_CONTEXT(ctx
);
125 ASSERT_OUTSIDE_BEGIN_END(ctx
);
132 if (TEST_EQ_4V(tmp
, ctx
->Color
.ClearColor
.ui
))
133 return; /* no change */
135 FLUSH_VERTICES(ctx
, _NEW_COLOR
);
136 COPY_4V(ctx
->Color
.ClearColor
.ui
, tmp
);
143 * \param mask bit-mask indicating the buffers to be cleared.
145 * Flushes the vertices and verifies the parameter. If __struct gl_contextRec::NewState
146 * is set then calls _mesa_update_state() to update gl_frame_buffer::_Xmin,
147 * etc. If the rasterization mode is set to GL_RENDER then requests the driver
148 * to clear the buffers, via the dd_function_table::Clear callback.
151 _mesa_Clear( GLbitfield mask
)
153 GET_CURRENT_CONTEXT(ctx
);
154 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
156 FLUSH_CURRENT(ctx
, 0);
158 if (MESA_VERBOSE
& VERBOSE_API
)
159 _mesa_debug(ctx
, "glClear 0x%x\n", mask
);
161 if (mask
& ~(GL_COLOR_BUFFER_BIT
|
162 GL_DEPTH_BUFFER_BIT
|
163 GL_STENCIL_BUFFER_BIT
|
164 GL_ACCUM_BUFFER_BIT
)) {
165 /* invalid bit set */
166 _mesa_error( ctx
, GL_INVALID_VALUE
, "glClear(0x%x)", mask
);
170 /* Accumulation buffers were removed in core contexts, and they never
171 * existed in OpenGL ES.
173 if ((mask
& GL_ACCUM_BUFFER_BIT
) != 0
174 && (ctx
->API
== API_OPENGL_CORE
|| _mesa_is_gles(ctx
))) {
175 _mesa_error( ctx
, GL_INVALID_VALUE
, "glClear(GL_ACCUM_BUFFER_BIT)");
180 _mesa_update_state( ctx
); /* update _Xmin, etc */
183 if (ctx
->DrawBuffer
->_Status
!= GL_FRAMEBUFFER_COMPLETE_EXT
) {
184 _mesa_error(ctx
, GL_INVALID_FRAMEBUFFER_OPERATION_EXT
,
185 "glClear(incomplete framebuffer)");
189 if (ctx
->DrawBuffer
->Width
== 0 || ctx
->DrawBuffer
->Height
== 0 ||
190 ctx
->DrawBuffer
->_Xmin
>= ctx
->DrawBuffer
->_Xmax
||
191 ctx
->DrawBuffer
->_Ymin
>= ctx
->DrawBuffer
->_Ymax
)
194 if (ctx
->RasterDiscard
)
197 if (ctx
->RenderMode
== GL_RENDER
) {
198 GLbitfield bufferMask
;
200 /* don't clear depth buffer if depth writing disabled */
201 if (!ctx
->Depth
.Mask
)
202 mask
&= ~GL_DEPTH_BUFFER_BIT
;
204 /* Build the bitmask to send to device driver's Clear function.
205 * Note that the GL_COLOR_BUFFER_BIT flag will expand to 0, 1, 2 or 4
206 * of the BUFFER_BIT_FRONT/BACK_LEFT/RIGHT flags, or one of the
207 * BUFFER_BIT_COLORn flags.
210 if (mask
& GL_COLOR_BUFFER_BIT
) {
212 for (i
= 0; i
< ctx
->DrawBuffer
->_NumColorDrawBuffers
; i
++) {
213 bufferMask
|= (1 << ctx
->DrawBuffer
->_ColorDrawBufferIndexes
[i
]);
217 if ((mask
& GL_DEPTH_BUFFER_BIT
)
218 && ctx
->DrawBuffer
->Visual
.haveDepthBuffer
) {
219 bufferMask
|= BUFFER_BIT_DEPTH
;
222 if ((mask
& GL_STENCIL_BUFFER_BIT
)
223 && ctx
->DrawBuffer
->Visual
.haveStencilBuffer
) {
224 bufferMask
|= BUFFER_BIT_STENCIL
;
227 if ((mask
& GL_ACCUM_BUFFER_BIT
)
228 && ctx
->DrawBuffer
->Visual
.haveAccumBuffer
) {
229 bufferMask
|= BUFFER_BIT_ACCUM
;
232 ASSERT(ctx
->Driver
.Clear
);
233 ctx
->Driver
.Clear(ctx
, bufferMask
);
238 /** Returned by make_color_buffer_mask() for errors */
239 #define INVALID_MASK ~0x0
243 * Convert the glClearBuffer 'drawbuffer' parameter into a bitmask of
244 * BUFFER_BIT_x values.
245 * Return INVALID_MASK if the drawbuffer value is invalid.
248 make_color_buffer_mask(struct gl_context
*ctx
, GLint drawbuffer
)
250 const struct gl_renderbuffer_attachment
*att
= ctx
->DrawBuffer
->Attachment
;
251 GLbitfield mask
= 0x0;
253 switch (drawbuffer
) {
255 if (att
[BUFFER_FRONT_LEFT
].Renderbuffer
)
256 mask
|= BUFFER_BIT_FRONT_LEFT
;
257 if (att
[BUFFER_FRONT_RIGHT
].Renderbuffer
)
258 mask
|= BUFFER_BIT_FRONT_RIGHT
;
261 if (att
[BUFFER_BACK_LEFT
].Renderbuffer
)
262 mask
|= BUFFER_BIT_BACK_LEFT
;
263 if (att
[BUFFER_BACK_RIGHT
].Renderbuffer
)
264 mask
|= BUFFER_BIT_BACK_RIGHT
;
267 if (att
[BUFFER_FRONT_LEFT
].Renderbuffer
)
268 mask
|= BUFFER_BIT_FRONT_LEFT
;
269 if (att
[BUFFER_BACK_LEFT
].Renderbuffer
)
270 mask
|= BUFFER_BIT_BACK_LEFT
;
273 if (att
[BUFFER_FRONT_RIGHT
].Renderbuffer
)
274 mask
|= BUFFER_BIT_FRONT_RIGHT
;
275 if (att
[BUFFER_BACK_RIGHT
].Renderbuffer
)
276 mask
|= BUFFER_BIT_BACK_RIGHT
;
278 case GL_FRONT_AND_BACK
:
279 if (att
[BUFFER_FRONT_LEFT
].Renderbuffer
)
280 mask
|= BUFFER_BIT_FRONT_LEFT
;
281 if (att
[BUFFER_BACK_LEFT
].Renderbuffer
)
282 mask
|= BUFFER_BIT_BACK_LEFT
;
283 if (att
[BUFFER_FRONT_RIGHT
].Renderbuffer
)
284 mask
|= BUFFER_BIT_FRONT_RIGHT
;
285 if (att
[BUFFER_BACK_RIGHT
].Renderbuffer
)
286 mask
|= BUFFER_BIT_BACK_RIGHT
;
289 if (drawbuffer
< 0 || drawbuffer
>= (GLint
)ctx
->Const
.MaxDrawBuffers
) {
292 else if (att
[BUFFER_COLOR0
+ drawbuffer
].Renderbuffer
) {
293 mask
|= (BUFFER_BIT_COLOR0
<< drawbuffer
);
304 * Clear signed integer color buffer or stencil buffer (not depth).
307 _mesa_ClearBufferiv(GLenum buffer
, GLint drawbuffer
, const GLint
*value
)
309 GET_CURRENT_CONTEXT(ctx
);
310 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
312 FLUSH_CURRENT(ctx
, 0);
315 _mesa_update_state( ctx
);
320 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
322 * "ClearBuffer generates an INVALID VALUE error if buffer is
323 * COLOR and drawbuffer is less than zero, or greater than the
324 * value of MAX DRAW BUFFERS minus one; or if buffer is DEPTH,
325 * STENCIL, or DEPTH STENCIL and drawbuffer is not zero."
327 if (drawbuffer
!= 0) {
328 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferiv(drawbuffer=%d)",
332 else if (ctx
->DrawBuffer
->Attachment
[BUFFER_STENCIL
].Renderbuffer
&& !ctx
->RasterDiscard
) {
333 /* Save current stencil clear value, set to 'value', do the
334 * stencil clear and restore the clear value.
335 * XXX in the future we may have a new ctx->Driver.ClearBuffer()
338 const GLuint clearSave
= ctx
->Stencil
.Clear
;
339 ctx
->Stencil
.Clear
= *value
;
340 ctx
->Driver
.Clear(ctx
, BUFFER_BIT_STENCIL
);
341 ctx
->Stencil
.Clear
= clearSave
;
346 const GLbitfield mask
= make_color_buffer_mask(ctx
, drawbuffer
);
347 if (mask
== INVALID_MASK
) {
348 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferiv(drawbuffer=%d)",
352 else if (mask
&& !ctx
->RasterDiscard
) {
353 union gl_color_union clearSave
;
356 clearSave
= ctx
->Color
.ClearColor
;
358 COPY_4V(ctx
->Color
.ClearColor
.i
, value
);
359 /* clear buffer(s) */
360 ctx
->Driver
.Clear(ctx
, mask
);
362 ctx
->Color
.ClearColor
= clearSave
;
367 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
369 * "The result of ClearBuffer is undefined if no conversion between
370 * the type of the specified value and the type of the buffer being
371 * cleared is defined (for example, if ClearBufferiv is called for a
372 * fixed- or floating-point buffer, or if ClearBufferfv is called
373 * for a signed or unsigned integer buffer). This is not an error."
375 * In this case we take "undefined" and "not an error" to mean "ignore."
376 * Note that we still need to generate an error for the invalid
377 * drawbuffer case (see the GL_STENCIL case above).
379 if (drawbuffer
!= 0) {
380 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferiv(drawbuffer=%d)",
386 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferiv(buffer=%s)",
387 _mesa_lookup_enum_by_nr(buffer
));
395 * Clear unsigned integer color buffer (not depth, not stencil).
398 _mesa_ClearBufferuiv(GLenum buffer
, GLint drawbuffer
, const GLuint
*value
)
400 GET_CURRENT_CONTEXT(ctx
);
401 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
403 FLUSH_CURRENT(ctx
, 0);
406 _mesa_update_state( ctx
);
412 const GLbitfield mask
= make_color_buffer_mask(ctx
, drawbuffer
);
413 if (mask
== INVALID_MASK
) {
414 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferuiv(drawbuffer=%d)",
418 else if (mask
&& !ctx
->RasterDiscard
) {
419 union gl_color_union clearSave
;
422 clearSave
= ctx
->Color
.ClearColor
;
424 COPY_4V(ctx
->Color
.ClearColor
.ui
, value
);
425 /* clear buffer(s) */
426 ctx
->Driver
.Clear(ctx
, mask
);
428 ctx
->Color
.ClearColor
= clearSave
;
434 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
436 * "The result of ClearBuffer is undefined if no conversion between
437 * the type of the specified value and the type of the buffer being
438 * cleared is defined (for example, if ClearBufferiv is called for a
439 * fixed- or floating-point buffer, or if ClearBufferfv is called
440 * for a signed or unsigned integer buffer). This is not an error."
442 * In this case we take "undefined" and "not an error" to mean "ignore."
443 * Even though we could do something sensible for GL_STENCIL, page 263
444 * (page 279 of the PDF) says:
446 * "Only ClearBufferiv should be used to clear stencil buffers."
448 * Note that we still need to generate an error for the invalid
449 * drawbuffer case (see the GL_STENCIL case in _mesa_ClearBufferiv).
451 if (drawbuffer
!= 0) {
452 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferuiv(drawbuffer=%d)",
458 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferuiv(buffer=%s)",
459 _mesa_lookup_enum_by_nr(buffer
));
467 * Clear fixed-pt or float color buffer or depth buffer (not stencil).
470 _mesa_ClearBufferfv(GLenum buffer
, GLint drawbuffer
, const GLfloat
*value
)
472 GET_CURRENT_CONTEXT(ctx
);
473 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
475 FLUSH_CURRENT(ctx
, 0);
478 _mesa_update_state( ctx
);
483 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
485 * "ClearBuffer generates an INVALID VALUE error if buffer is
486 * COLOR and drawbuffer is less than zero, or greater than the
487 * value of MAX DRAW BUFFERS minus one; or if buffer is DEPTH,
488 * STENCIL, or DEPTH STENCIL and drawbuffer is not zero."
490 if (drawbuffer
!= 0) {
491 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfv(drawbuffer=%d)",
495 else if (ctx
->DrawBuffer
->Attachment
[BUFFER_DEPTH
].Renderbuffer
&& !ctx
->RasterDiscard
) {
496 /* Save current depth clear value, set to 'value', do the
497 * depth clear and restore the clear value.
498 * XXX in the future we may have a new ctx->Driver.ClearBuffer()
501 const GLclampd clearSave
= ctx
->Depth
.Clear
;
502 ctx
->Depth
.Clear
= *value
;
503 ctx
->Driver
.Clear(ctx
, BUFFER_BIT_DEPTH
);
504 ctx
->Depth
.Clear
= clearSave
;
506 /* clear depth buffer to value */
510 const GLbitfield mask
= make_color_buffer_mask(ctx
, drawbuffer
);
511 if (mask
== INVALID_MASK
) {
512 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfv(drawbuffer=%d)",
516 else if (mask
&& !ctx
->RasterDiscard
) {
517 union gl_color_union clearSave
;
520 clearSave
= ctx
->Color
.ClearColor
;
522 COPY_4V(ctx
->Color
.ClearColor
.f
, value
);
523 /* clear buffer(s) */
524 ctx
->Driver
.Clear(ctx
, mask
);
526 ctx
->Color
.ClearColor
= clearSave
;
531 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
533 * "The result of ClearBuffer is undefined if no conversion between
534 * the type of the specified value and the type of the buffer being
535 * cleared is defined (for example, if ClearBufferiv is called for a
536 * fixed- or floating-point buffer, or if ClearBufferfv is called
537 * for a signed or unsigned integer buffer). This is not an error."
539 * In this case we take "undefined" and "not an error" to mean "ignore."
540 * Note that we still need to generate an error for the invalid
541 * drawbuffer case (see the GL_DEPTH case above).
543 if (drawbuffer
!= 0) {
544 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfv(drawbuffer=%d)",
550 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferfv(buffer=%s)",
551 _mesa_lookup_enum_by_nr(buffer
));
559 * Clear depth/stencil buffer only.
562 _mesa_ClearBufferfi(GLenum buffer
, GLint drawbuffer
,
563 GLfloat depth
, GLint stencil
)
565 GET_CURRENT_CONTEXT(ctx
);
568 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
570 FLUSH_CURRENT(ctx
, 0);
572 if (buffer
!= GL_DEPTH_STENCIL
) {
573 _mesa_error(ctx
, GL_INVALID_ENUM
, "glClearBufferfi(buffer=%s)",
574 _mesa_lookup_enum_by_nr(buffer
));
578 /* Page 264 (page 280 of the PDF) of the OpenGL 3.0 spec says:
580 * "ClearBuffer generates an INVALID VALUE error if buffer is
581 * COLOR and drawbuffer is less than zero, or greater than the
582 * value of MAX DRAW BUFFERS minus one; or if buffer is DEPTH,
583 * STENCIL, or DEPTH STENCIL and drawbuffer is not zero."
585 if (drawbuffer
!= 0) {
586 _mesa_error(ctx
, GL_INVALID_VALUE
, "glClearBufferfi(drawbuffer=%d)",
591 if (ctx
->RasterDiscard
)
595 _mesa_update_state( ctx
);
598 if (ctx
->DrawBuffer
->Attachment
[BUFFER_DEPTH
].Renderbuffer
)
599 mask
|= BUFFER_BIT_DEPTH
;
600 if (ctx
->DrawBuffer
->Attachment
[BUFFER_STENCIL
].Renderbuffer
)
601 mask
|= BUFFER_BIT_STENCIL
;
604 /* save current clear values */
605 const GLclampd clearDepthSave
= ctx
->Depth
.Clear
;
606 const GLuint clearStencilSave
= ctx
->Stencil
.Clear
;
608 /* set new clear values */
609 ctx
->Depth
.Clear
= depth
;
610 ctx
->Stencil
.Clear
= stencil
;
613 ctx
->Driver
.Clear(ctx
, mask
);
616 ctx
->Depth
.Clear
= clearDepthSave
;
617 ctx
->Stencil
.Clear
= clearStencilSave
;