Blender V5.3
GPU_state.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_enum_flags.hh"
12#include "BLI_sys_types.hh"
13
14namespace blender {
15
17struct GPUFence;
18
29
31
33 /* Texture Barrier. */
34
44 // GPU_BARRIER_PIXEL_BUFFER = (1 << 4), /* Not implemented yet. */
45
46 /* Buffer Barrier. */
47
61 // GPU_BARRIER_CLIENT_MAPPED_BUFFER = (1 << 15), /* Not implemented yet. */
62};
63
65
66/* NOTE: For Metal and Vulkan only.
67 * TODO(Metal): Update barrier calls to use stage flags. */
76
78
79
130
133 GPU_DEPTH_ALWAYS, /* Used to draw to the depth buffer without really testing. */
135 GPU_DEPTH_LESS_EQUAL, /* Default. */
139};
140
147
155
157 GPU_CULL_NONE = 0, /* Culling disabled. */
160};
161
163 GPU_VERTEX_LAST = 0, /* Default. */
164 GPU_VERTEX_FIRST = 1, /* Follow Blender loop order. */
165};
166
167void GPU_blend(GPUBlend blend);
172void GPU_front_facing(bool invert);
173void GPU_scissor_test(bool enable);
174void GPU_line_smooth(bool enable);
180void GPU_line_width(float width);
181
182void GPU_point_size(float size);
183void GPU_polygon_smooth(bool enable);
184
192void GPU_program_point_size(bool enable);
193void GPU_scissor(int x, int y, int width, int height);
194void GPU_scissor_get(int coords[4]);
195void GPU_viewport(int x, int y, int width, int height);
196void GPU_viewport_size_get_f(float coords[4]);
197void GPU_viewport_size_get_i(int coords[4]);
199void GPU_color_mask(bool r, bool g, bool b, bool a);
200void GPU_depth_mask(bool depth);
201bool GPU_depth_mask_get();
202void GPU_clip_distances(int distances_enabled);
203void GPU_state_set(GPUWriteMask write_mask,
204 GPUBlend blend,
205 GPUFaceCullTest culling_test,
206 GPUDepthTest depth_test,
207 GPUStencilTest stencil_test,
208 GPUStencilOp stencil_op,
209 GPUProvokingVertex provoking_vert);
210
211void GPU_stencil_reference_set(uint reference);
212void GPU_stencil_write_mask_set(uint write_mask);
213void GPU_stencil_compare_mask_set(uint compare_mask);
214
215/* Sets the depth range to be 0..1. Only have effect with the OpenGL backend. Have no effect if
216 * glClipControl is not supported. Shaders used for drawing with this state must use
217 * BuiltinBits::CLIP_CONTROL for their vertex shader to be patched. */
218void GPU_clip_control_unit_range(bool enable);
219
229float GPU_line_width_get();
231
232void GPU_flush();
233void GPU_finish();
234void GPU_apply_state();
235
245
246GPUFence *GPU_fence_create();
247void GPU_fence_free(GPUFence *fence);
248void GPU_fence_signal(GPUFence *fence);
249void GPU_fence_wait(GPUFence *fence);
250
251} // namespace blender
#define ENUM_OPERATORS(_enum_type)
static DBVT_INLINE btScalar size(const btDbvtVolume &a)
Definition btDbvt.cpp:52
void barrier()
float2x2 invert(float2x2 mat)
ccl_device_inline float2 mask(const MaskType mask, const float2 a)
BMesh Iterators.
void GPU_provoking_vertex(GPUProvokingVertex vert)
Definition gpu_state.cc:65
void GPU_scissor_test(bool enable)
Definition gpu_state.cc:173
@ GPU_CULL_FRONT
Definition GPU_state.hh:158
@ GPU_CULL_NONE
Definition GPU_state.hh:157
@ GPU_CULL_BACK
Definition GPU_state.hh:159
@ GPU_STENCIL_OP_COUNT_DEPTH_FAIL
Definition GPU_state.hh:153
@ GPU_STENCIL_OP_COUNT_DEPTH_PASS
Definition GPU_state.hh:152
@ GPU_STENCIL_OP_NONE
Definition GPU_state.hh:149
@ GPU_STENCIL_OP_REPLACE
Definition GPU_state.hh:150
void GPU_fence_free(GPUFence *fence)
Definition gpu_state.cc:316
void GPU_state_set(GPUWriteMask write_mask, GPUBlend blend, GPUFaceCullTest culling_test, GPUDepthTest depth_test, GPUStencilTest stencil_test, GPUStencilOp stencil_op, GPUProvokingVertex provoking_vert)
Definition gpu_state.cc:121
GPUWriteMask GPU_write_mask_get()
Definition gpu_state.cc:217
GPUStageBarrierBits
Definition GPU_state.hh:68
@ GPU_BARRIER_STAGE_FRAGMENT
Definition GPU_state.hh:70
@ GPU_BARRIER_STAGE_VERTEX
Definition GPU_state.hh:69
@ GPU_BARRIER_STAGE_ANY
Definition GPU_state.hh:73
@ GPU_BARRIER_STAGE_ANY_GRAPHICS
Definition GPU_state.hh:72
@ GPU_BARRIER_STAGE_COMPUTE
Definition GPU_state.hh:71
unsigned int uint
Definition BKE_text.h:55
void GPU_polygon_smooth(bool enable)
Definition gpu_state.cc:85
void GPU_clip_distances(int distances_enabled)
Definition gpu_state.cc:116
GPUDepthTest GPU_depth_test_get()
Definition gpu_state.cc:229
GPUStencilTest GPU_stencil_test_get()
Definition gpu_state.cc:235
void GPU_point_size(float size)
Definition gpu_state.cc:157
void GPU_line_smooth(bool enable)
Definition gpu_state.cc:80
void GPU_depth_mask(bool depth)
Definition gpu_state.cc:107
void GPU_fence_wait(GPUFence *fence)
Definition gpu_state.cc:326
GPUFaceCullTest GPU_face_culling_get()
Definition gpu_state.cc:54
void GPU_apply_state()
Definition gpu_state.cc:294
void GPU_line_width(float width)
Definition gpu_state.cc:151
void GPU_stencil_reference_set(uint reference)
Definition gpu_state.cc:190
@ GPU_BLEND_MIN
Definition GPU_state.hh:102
@ GPU_BLEND_OVERLAY_MASK_FROM_ALPHA
Definition GPU_state.hh:122
@ GPU_BLEND_TRANSPARENCY
Definition GPU_state.hh:128
@ GPU_BLEND_NONE
Definition GPU_state.hh:88
@ GPU_BLEND_OIT
Definition GPU_state.hh:109
@ GPU_BLEND_MAX
Definition GPU_state.hh:104
@ GPU_BLEND_ALPHA_UNDER_PREMUL
Definition GPU_state.hh:117
@ GPU_BLEND_ADDITIVE_PREMULT
Definition GPU_state.hh:93
@ GPU_BLEND_ALPHA
Definition GPU_state.hh:90
@ GPU_BLEND_ADDITIVE
Definition GPU_state.hh:92
@ GPU_BLEND_BACKGROUND
Definition GPU_state.hh:111
@ GPU_BLEND_SUBTRACT
Definition GPU_state.hh:95
@ GPU_BLEND_ALPHA_PREMULT
Definition GPU_state.hh:91
@ GPU_BLEND_INVERT
Definition GPU_state.hh:100
@ GPU_BLEND_MULTIPLY
Definition GPU_state.hh:94
@ GPU_BLEND_CUSTOM
Definition GPU_state.hh:116
GPUFence * GPU_fence_create()
Definition gpu_state.cc:310
float GPU_line_width_get()
Definition gpu_state.cc:241
@ GPU_DEPTH_NONE
Definition GPU_state.hh:132
@ GPU_DEPTH_LESS_EQUAL
Definition GPU_state.hh:135
@ GPU_DEPTH_ALWAYS
Definition GPU_state.hh:133
@ GPU_DEPTH_GREATER
Definition GPU_state.hh:137
@ GPU_DEPTH_LESS
Definition GPU_state.hh:134
@ GPU_DEPTH_GREATER_EQUAL
Definition GPU_state.hh:138
@ GPU_DEPTH_EQUAL
Definition GPU_state.hh:136
void GPU_memory_barrier(GPUBarrier barrier)
Definition gpu_state.cc:305
void GPU_viewport_size_get_f(float coords[4])
Definition gpu_state.cc:258
uint GPU_stencil_mask_get()
Definition gpu_state.cc:223
void GPU_scissor_get(int coords[4])
Definition gpu_state.cc:253
bool GPU_depth_mask_get()
Definition gpu_state.cc:272
void GPU_color_mask(bool r, bool g, bool b, bool a)
Definition gpu_state.cc:95
void GPU_stencil_test(GPUStencilTest test)
Definition gpu_state.cc:75
void GPU_program_point_size(bool enable)
Definition gpu_state.cc:165
@ GPU_BARRIER_VERTEX_ATTRIB_ARRAY
Definition GPU_state.hh:53
@ GPU_BARRIER_FRAMEBUFFER
Definition GPU_state.hh:36
@ GPU_BARRIER_BUFFER_UPDATE
Definition GPU_state.hh:59
@ GPU_BARRIER_COMMAND
Definition GPU_state.hh:49
@ GPU_BARRIER_TEXTURE_FETCH
Definition GPU_state.hh:40
@ GPU_BARRIER_SHADER_STORAGE
Definition GPU_state.hh:51
@ GPU_BARRIER_UNIFORM
Definition GPU_state.hh:57
@ GPU_BARRIER_TEXTURE_UPDATE
Definition GPU_state.hh:42
@ GPU_BARRIER_SHADER_IMAGE_ACCESS
Definition GPU_state.hh:38
@ GPU_BARRIER_ELEMENT_ARRAY
Definition GPU_state.hh:55
@ GPU_STENCIL_ALWAYS
Definition GPU_state.hh:143
@ GPU_STENCIL_EQUAL
Definition GPU_state.hh:144
@ GPU_STENCIL_NONE
Definition GPU_state.hh:142
@ GPU_STENCIL_NEQUAL
Definition GPU_state.hh:145
void GPU_scissor(int x, int y, int width, int height)
Definition gpu_state.cc:178
void GPU_flush()
Definition gpu_state.cc:284
bool GPU_line_smooth_get()
Definition gpu_state.cc:247
GPUBlend GPU_blend_get()
Definition gpu_state.cc:211
@ GPU_WRITE_NONE
Definition GPU_state.hh:20
@ GPU_WRITE_ALPHA
Definition GPU_state.hh:24
@ GPU_WRITE_COLOR
Definition GPU_state.hh:27
@ GPU_WRITE_RED
Definition GPU_state.hh:21
@ GPU_WRITE_BLUE
Definition GPU_state.hh:23
@ GPU_WRITE_STENCIL
Definition GPU_state.hh:26
@ GPU_WRITE_GREEN
Definition GPU_state.hh:22
@ GPU_WRITE_DEPTH
Definition GPU_state.hh:25
void GPU_viewport(int x, int y, int width, int height)
Definition gpu_state.cc:184
void GPU_clip_control_unit_range(bool enable)
Definition gpu_state.cc:140
void GPU_viewport_size_get_i(int coords[4])
Definition gpu_state.cc:267
void GPU_face_culling(GPUFaceCullTest culling)
Definition gpu_state.cc:49
GPUProvokingVertex
Definition GPU_state.hh:162
@ GPU_VERTEX_LAST
Definition GPU_state.hh:163
@ GPU_VERTEX_FIRST
Definition GPU_state.hh:164
void GPU_front_facing(bool invert)
Definition gpu_state.cc:60
void GPU_stencil_write_mask_set(uint write_mask)
Definition gpu_state.cc:195
void GPU_blend(GPUBlend blend)
Definition gpu_state.cc:44
void GPU_fence_signal(GPUFence *fence)
Definition gpu_state.cc:321
void GPU_finish()
Definition gpu_state.cc:289
void GPU_depth_test(GPUDepthTest test)
Definition gpu_state.cc:70
void GPU_stencil_compare_mask_set(uint compare_mask)
Definition gpu_state.cc:200
void GPU_write_mask(GPUWriteMask mask)
Definition gpu_state.cc:90