1/**
2 * Copyright (c) 2006-2023 LOVE Development Team
3 *
4 * This software is provided 'as-is', without any express or implied
5 * warranty. In no event will the authors be held liable for any damages
6 * arising from the use of this software.
7 *
8 * Permission is granted to anyone to use this software for any purpose,
9 * including commercial applications, and to alter it and redistribute it
10 * freely, subject to the following restrictions:
11 *
12 * 1. The origin of this software must not be misrepresented; you must not
13 * claim that you wrote the original software. If you use this software
14 * in a product, an acknowledgment in the product documentation would be
15 * appreciated but is not required.
16 * 2. Altered source versions must be plainly marked as such, and must not be
17 * misrepresented as being the original software.
18 * 3. This notice may not be removed or altered from any source distribution.
19 **/
20
21#pragma once
22
23#include <vector>
24#include <string>
25
26namespace love
27{
28namespace graphics
29{
30
31enum StencilAction
32{
33 STENCIL_REPLACE,
34 STENCIL_INCREMENT,
35 STENCIL_DECREMENT,
36 STENCIL_INCREMENT_WRAP,
37 STENCIL_DECREMENT_WRAP,
38 STENCIL_INVERT,
39 STENCIL_MAX_ENUM
40};
41
42enum CompareMode
43{
44 COMPARE_LESS,
45 COMPARE_LEQUAL,
46 COMPARE_EQUAL,
47 COMPARE_GEQUAL,
48 COMPARE_GREATER,
49 COMPARE_NOTEQUAL,
50 COMPARE_ALWAYS,
51 COMPARE_NEVER,
52 COMPARE_MAX_ENUM
53};
54
55/**
56 * GPU APIs do the comparison in the opposite way of what makes sense for some
57 * of love's APIs. For example in OpenGL if the compare function is GL_GREATER,
58 * then the stencil test will pass if the reference value is greater than the
59 * value in the stencil buffer. With our stencil API it's more intuitive to
60 * assume that setStencilTest(COMPARE_GREATER, 4) will make it pass if the
61 * stencil buffer has a value greater than 4.
62 **/
63CompareMode getReversedCompareMode(CompareMode mode);
64
65bool getConstant(const char *in, StencilAction &out);
66bool getConstant(StencilAction in, const char *&out);
67std::vector<std::string> getConstants(StencilAction);
68
69bool getConstant(const char *in, CompareMode &out);
70bool getConstant(CompareMode in, const char *&out);
71std::vector<std::string> getConstants(CompareMode);
72
73} // graphics
74} // love
75