stencil.h revision af69d88d 
1/**
2 * \file stencil.h
3 * Stencil operations.
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 STENCIL_H
32#define STENCIL_H
33
34
35#include "glheader.h"
36
37struct gl_context;
38
39extern void GLAPIENTRY
40_mesa_ClearStencil( GLint s );
41
42
43extern void GLAPIENTRY
44_mesa_StencilFunc( GLenum func, GLint ref, GLuint mask );
45
46
47extern void GLAPIENTRY
48_mesa_StencilMask( GLuint mask );
49
50
51extern void GLAPIENTRY
52_mesa_StencilOp( GLenum fail, GLenum zfail, GLenum zpass );
53
54
55extern void GLAPIENTRY
56_mesa_ActiveStencilFaceEXT(GLenum face);
57
58
59extern void GLAPIENTRY
60_mesa_StencilOpSeparate(GLenum face, GLenum fail, GLenum zfail, GLenum zpass);
61
62
63extern void GLAPIENTRY
64_mesa_StencilFuncSeparate(GLenum face, GLenum func, GLint ref, GLuint mask);
65
66
67extern void GLAPIENTRY
68_mesa_StencilFuncSeparateATI(GLenum frontfunc, GLenum backfunc, GLint ref, GLuint mask);
69
70extern void GLAPIENTRY
71_mesa_StencilMaskSeparate(GLenum face, GLuint mask);
72
73
74extern void
75_mesa_update_stencil(struct gl_context *ctx);
76
77
78extern void
79_mesa_init_stencil( struct gl_context * ctx );
80
81/* From the GL 4.3 spec, 17.3.5:
82 *    "Stencil comparison operations and queries of <ref> clamp its value
83 *    to the range [0, 2^s-1], where <s> is the number of bits in the
84 *    stencil buffer attached to the draw framebuffer."
85 */
86
87static inline GLint
88_mesa_get_stencil_ref(struct gl_context const *ctx, int face)
89{
90   GLint stencilMax = (1 << ctx->DrawBuffer->Visual.stencilBits) - 1;
91   GLint ref = ctx->Stencil.Ref[face];
92   return CLAMP(ref, 0, stencilMax);
93}
94
95#endif
96