Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/servers/rendering_server.h
9887 views
1
/**************************************************************************/
2
/* rendering_server.h */
3
/**************************************************************************/
4
/* This file is part of: */
5
/* GODOT ENGINE */
6
/* https://godotengine.org */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10
/* */
11
/* Permission is hereby granted, free of charge, to any person obtaining */
12
/* a copy of this software and associated documentation files (the */
13
/* "Software"), to deal in the Software without restriction, including */
14
/* without limitation the rights to use, copy, modify, merge, publish, */
15
/* distribute, sublicense, and/or sell copies of the Software, and to */
16
/* permit persons to whom the Software is furnished to do so, subject to */
17
/* the following conditions: */
18
/* */
19
/* The above copyright notice and this permission notice shall be */
20
/* included in all copies or substantial portions of the Software. */
21
/* */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29
/**************************************************************************/
30
31
#pragma once
32
33
#include "core/io/image.h"
34
#include "core/math/geometry_3d.h"
35
#include "core/math/transform_2d.h"
36
#include "core/templates/rid.h"
37
#include "core/variant/typed_array.h"
38
#include "core/variant/variant.h"
39
#include "servers/display_server.h"
40
#include "servers/rendering/rendering_device.h"
41
42
// Helper macros for code outside of the rendering server, but that is
43
// called by the rendering server.
44
#ifdef DEBUG_ENABLED
45
#define ERR_NOT_ON_RENDER_THREAD \
46
RenderingServer *rendering_server = RenderingServer::get_singleton(); \
47
ERR_FAIL_NULL(rendering_server); \
48
ERR_FAIL_COND(!rendering_server->is_on_render_thread());
49
#define ERR_NOT_ON_RENDER_THREAD_V(m_ret) \
50
RenderingServer *rendering_server = RenderingServer::get_singleton(); \
51
ERR_FAIL_NULL_V(rendering_server, m_ret); \
52
ERR_FAIL_COND_V(!rendering_server->is_on_render_thread(), m_ret);
53
#else
54
#define ERR_NOT_ON_RENDER_THREAD
55
#define ERR_NOT_ON_RENDER_THREAD_V(m_ret)
56
#endif
57
58
class RenderingServer : public Object {
59
GDCLASS(RenderingServer, Object);
60
61
static RenderingServer *singleton;
62
63
int mm_policy = 0;
64
bool render_loop_enabled = true;
65
66
Array _get_array_from_surface(uint64_t p_format, Vector<uint8_t> p_vertex_data, Vector<uint8_t> p_attrib_data, Vector<uint8_t> p_skin_data, int p_vertex_len, Vector<uint8_t> p_index_data, int p_index_len, const AABB &p_aabb, const Vector4 &p_uv_scale) const;
67
68
const Vector2 SMALL_VEC2 = Vector2(CMP_EPSILON, CMP_EPSILON);
69
const Vector3 SMALL_VEC3 = Vector3(CMP_EPSILON, CMP_EPSILON, CMP_EPSILON);
70
71
virtual TypedArray<StringName> _global_shader_parameter_get_list() const;
72
73
protected:
74
RID _make_test_cube();
75
void _free_internal_rids();
76
RID test_texture;
77
RID white_texture;
78
RID test_material;
79
80
Error _surface_set_data(Array p_arrays, uint64_t p_format, uint32_t *p_offsets, uint32_t p_vertex_stride, uint32_t p_normal_stride, uint32_t p_attrib_stride, uint32_t p_skin_stride, Vector<uint8_t> &r_vertex_array, Vector<uint8_t> &r_attrib_array, Vector<uint8_t> &r_skin_array, int p_vertex_array_len, Vector<uint8_t> &r_index_array, int p_index_array_len, AABB &r_aabb, Vector<AABB> &r_bone_aabb, Vector4 &r_uv_scale);
81
82
static RenderingServer *(*create_func)();
83
static void _bind_methods();
84
85
#ifndef DISABLE_DEPRECATED
86
void _environment_set_fog_bind_compat_84792(RID p_env, bool p_enable, const Color &p_light_color, float p_light_energy, float p_sun_scatter, float p_density, float p_height, float p_height_density, float p_aerial_perspective, float p_sky_affect);
87
void _canvas_item_add_multiline_bind_compat_84523(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0);
88
void _canvas_item_add_rect_bind_compat_84523(RID p_item, const Rect2 &p_rect, const Color &p_color);
89
void _canvas_item_add_circle_bind_compat_84523(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color);
90
void _instance_set_interpolated_bind_compat_104269(RID p_instance, bool p_interpolated);
91
void _instance_reset_physics_interpolation_bind_compat_104269(RID p_instance);
92
93
static void _bind_compatibility_methods();
94
#endif
95
96
public:
97
static RenderingServer *get_singleton();
98
static RenderingServer *create();
99
100
enum {
101
NO_INDEX_ARRAY = -1,
102
ARRAY_WEIGHTS_SIZE = 4,
103
CANVAS_ITEM_Z_MIN = -4096,
104
CANVAS_ITEM_Z_MAX = 4096,
105
CANVAS_LAYER_MIN = -2147483648,
106
CANVAS_LAYER_MAX = 2147483647,
107
MAX_GLOW_LEVELS = 7,
108
MAX_CURSORS = 8,
109
MAX_2D_DIRECTIONAL_LIGHTS = 8,
110
MAX_MESH_SURFACES = 256
111
};
112
113
/* TEXTURE API */
114
115
enum TextureType {
116
TEXTURE_TYPE_2D,
117
TEXTURE_TYPE_LAYERED,
118
TEXTURE_TYPE_3D,
119
};
120
121
enum TextureLayeredType {
122
TEXTURE_LAYERED_2D_ARRAY,
123
TEXTURE_LAYERED_CUBEMAP,
124
TEXTURE_LAYERED_CUBEMAP_ARRAY,
125
};
126
127
enum CubeMapLayer {
128
CUBEMAP_LAYER_LEFT,
129
CUBEMAP_LAYER_RIGHT,
130
CUBEMAP_LAYER_BOTTOM,
131
CUBEMAP_LAYER_TOP,
132
CUBEMAP_LAYER_FRONT,
133
CUBEMAP_LAYER_BACK
134
};
135
136
virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;
137
virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, TextureLayeredType p_layered_type) = 0;
138
virtual RID texture_3d_create(Image::Format, int p_width, int p_height, int p_depth, bool p_mipmaps, const Vector<Ref<Image>> &p_data) = 0; //all slices, then all the mipmaps, must be coherent
139
virtual RID texture_external_create(int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;
140
virtual RID texture_proxy_create(RID p_base) = 0;
141
142
virtual RID texture_create_from_native_handle(TextureType p_type, Image::Format p_format, uint64_t p_native_handle, int p_width, int p_height, int p_depth, int p_layers = 1, TextureLayeredType p_layered_type = TEXTURE_LAYERED_2D_ARRAY) = 0;
143
144
virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;
145
virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;
146
virtual void texture_external_update(RID p_texture, int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;
147
virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;
148
149
// These two APIs can be used together or in combination with the others.
150
virtual RID texture_2d_placeholder_create() = 0;
151
virtual RID texture_2d_layered_placeholder_create(TextureLayeredType p_layered_type) = 0;
152
virtual RID texture_3d_placeholder_create() = 0;
153
154
virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;
155
virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;
156
virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;
157
158
virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;
159
virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;
160
161
virtual void texture_set_path(RID p_texture, const String &p_path) = 0;
162
virtual String texture_get_path(RID p_texture) const = 0;
163
164
virtual Image::Format texture_get_format(RID p_texture) const = 0;
165
166
typedef void (*TextureDetectCallback)(void *);
167
168
virtual void texture_set_detect_3d_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
169
virtual void texture_set_detect_normal_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;
170
171
enum TextureDetectRoughnessChannel {
172
TEXTURE_DETECT_ROUGHNESS_R,
173
TEXTURE_DETECT_ROUGHNESS_G,
174
TEXTURE_DETECT_ROUGHNESS_B,
175
TEXTURE_DETECT_ROUGHNESS_A,
176
TEXTURE_DETECT_ROUGHNESS_GRAY,
177
};
178
179
typedef void (*TextureDetectRoughnessCallback)(void *, const String &, TextureDetectRoughnessChannel);
180
virtual void texture_set_detect_roughness_callback(RID p_texture, TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;
181
182
struct TextureInfo {
183
RID texture;
184
uint32_t width;
185
uint32_t height;
186
uint32_t depth;
187
Image::Format format;
188
int64_t bytes;
189
String path;
190
TextureType type;
191
};
192
193
virtual void texture_debug_usage(List<TextureInfo> *r_info) = 0;
194
Array _texture_debug_usage_bind();
195
196
virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;
197
198
virtual RID texture_rd_create(const RID &p_rd_texture, const RenderingServer::TextureLayeredType p_layer_type = RenderingServer::TEXTURE_LAYERED_2D_ARRAY) = 0;
199
virtual RID texture_get_rd_texture(RID p_texture, bool p_srgb = false) const = 0;
200
virtual uint64_t texture_get_native_handle(RID p_texture, bool p_srgb = false) const = 0;
201
202
/* PIPELINES API */
203
204
enum PipelineSource {
205
PIPELINE_SOURCE_CANVAS,
206
PIPELINE_SOURCE_MESH,
207
PIPELINE_SOURCE_SURFACE,
208
PIPELINE_SOURCE_DRAW,
209
PIPELINE_SOURCE_SPECIALIZATION,
210
PIPELINE_SOURCE_MAX
211
};
212
213
/* SHADER API */
214
215
enum ShaderMode {
216
SHADER_SPATIAL,
217
SHADER_CANVAS_ITEM,
218
SHADER_PARTICLES,
219
SHADER_SKY,
220
SHADER_FOG,
221
SHADER_MAX
222
};
223
224
enum CullMode {
225
CULL_MODE_DISABLED,
226
CULL_MODE_FRONT,
227
CULL_MODE_BACK,
228
};
229
230
virtual RID shader_create() = 0;
231
virtual RID shader_create_from_code(const String &p_code, const String &p_path_hint = String()) = 0;
232
233
virtual void shader_set_code(RID p_shader, const String &p_code) = 0;
234
virtual void shader_set_path_hint(RID p_shader, const String &p_path) = 0;
235
virtual String shader_get_code(RID p_shader) const = 0;
236
virtual void get_shader_parameter_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;
237
virtual Variant shader_get_parameter_default(RID p_shader, const StringName &p_param) const = 0;
238
239
virtual void shader_set_default_texture_parameter(RID p_shader, const StringName &p_name, RID p_texture, int p_index = 0) = 0;
240
virtual RID shader_get_default_texture_parameter(RID p_shader, const StringName &p_name, int p_index = 0) const = 0;
241
242
struct ShaderNativeSourceCode {
243
struct Version {
244
struct Stage {
245
String name;
246
String code;
247
};
248
Vector<Stage> stages;
249
};
250
Vector<Version> versions;
251
};
252
253
virtual ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;
254
255
/* COMMON MATERIAL API */
256
257
enum {
258
MATERIAL_RENDER_PRIORITY_MIN = -128,
259
MATERIAL_RENDER_PRIORITY_MAX = 127,
260
};
261
262
virtual RID material_create() = 0;
263
virtual RID material_create_from_shader(RID p_next_pass, int p_render_priority, RID p_shader) = 0;
264
265
virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;
266
267
virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;
268
virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;
269
270
virtual void material_set_render_priority(RID p_material, int priority) = 0;
271
272
virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;
273
274
/* MESH API */
275
276
enum ArrayType {
277
ARRAY_VERTEX = 0, // RG32F (2D), RGB32F, RGBA16 (compressed)
278
ARRAY_NORMAL = 1, // RG16
279
ARRAY_TANGENT = 2, // BA16 (with normal) or A16 (with vertex, when compressed)
280
ARRAY_COLOR = 3, // RGBA8
281
ARRAY_TEX_UV = 4, // RG32F or RG16
282
ARRAY_TEX_UV2 = 5, // RG32F or RG16
283
ARRAY_CUSTOM0 = 6, // Depends on ArrayCustomFormat.
284
ARRAY_CUSTOM1 = 7,
285
ARRAY_CUSTOM2 = 8,
286
ARRAY_CUSTOM3 = 9,
287
ARRAY_BONES = 10, // RGBA16UI (x2 if 8 weights)
288
ARRAY_WEIGHTS = 11, // RGBA16UNORM (x2 if 8 weights)
289
ARRAY_INDEX = 12, // 16 or 32 bits depending on length > 0xFFFF.
290
ARRAY_MAX = 13
291
};
292
293
enum {
294
ARRAY_CUSTOM_COUNT = ARRAY_BONES - ARRAY_CUSTOM0
295
};
296
297
enum ArrayCustomFormat {
298
ARRAY_CUSTOM_RGBA8_UNORM,
299
ARRAY_CUSTOM_RGBA8_SNORM,
300
ARRAY_CUSTOM_RG_HALF,
301
ARRAY_CUSTOM_RGBA_HALF,
302
ARRAY_CUSTOM_R_FLOAT,
303
ARRAY_CUSTOM_RG_FLOAT,
304
ARRAY_CUSTOM_RGB_FLOAT,
305
ARRAY_CUSTOM_RGBA_FLOAT,
306
ARRAY_CUSTOM_MAX
307
};
308
309
enum ArrayFormat : uint64_t {
310
/* ARRAY FORMAT FLAGS */
311
ARRAY_FORMAT_VERTEX = 1 << ARRAY_VERTEX,
312
ARRAY_FORMAT_NORMAL = 1 << ARRAY_NORMAL,
313
ARRAY_FORMAT_TANGENT = 1 << ARRAY_TANGENT,
314
ARRAY_FORMAT_COLOR = 1 << ARRAY_COLOR,
315
ARRAY_FORMAT_TEX_UV = 1 << ARRAY_TEX_UV,
316
ARRAY_FORMAT_TEX_UV2 = 1 << ARRAY_TEX_UV2,
317
ARRAY_FORMAT_CUSTOM0 = 1 << ARRAY_CUSTOM0,
318
ARRAY_FORMAT_CUSTOM1 = 1 << ARRAY_CUSTOM1,
319
ARRAY_FORMAT_CUSTOM2 = 1 << ARRAY_CUSTOM2,
320
ARRAY_FORMAT_CUSTOM3 = 1 << ARRAY_CUSTOM3,
321
ARRAY_FORMAT_BONES = 1 << ARRAY_BONES,
322
ARRAY_FORMAT_WEIGHTS = 1 << ARRAY_WEIGHTS,
323
ARRAY_FORMAT_INDEX = 1 << ARRAY_INDEX,
324
325
ARRAY_FORMAT_BLEND_SHAPE_MASK = ARRAY_FORMAT_VERTEX | ARRAY_FORMAT_NORMAL | ARRAY_FORMAT_TANGENT,
326
327
ARRAY_FORMAT_CUSTOM_BASE = (ARRAY_INDEX + 1),
328
ARRAY_FORMAT_CUSTOM_BITS = 3,
329
ARRAY_FORMAT_CUSTOM_MASK = 0x7,
330
ARRAY_FORMAT_CUSTOM0_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + 0),
331
ARRAY_FORMAT_CUSTOM1_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS),
332
ARRAY_FORMAT_CUSTOM2_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 2),
333
ARRAY_FORMAT_CUSTOM3_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 3),
334
335
ARRAY_COMPRESS_FLAGS_BASE = (ARRAY_INDEX + 1 + 12),
336
337
ARRAY_FLAG_USE_2D_VERTICES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 0),
338
ARRAY_FLAG_USE_DYNAMIC_UPDATE = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 1),
339
ARRAY_FLAG_USE_8_BONE_WEIGHTS = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 2),
340
341
ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 3),
342
343
ARRAY_FLAG_COMPRESS_ATTRIBUTES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 4),
344
// We leave enough room for up to 5 more compression flags.
345
346
ARRAY_FLAG_FORMAT_VERSION_BASE = ARRAY_COMPRESS_FLAGS_BASE + 10,
347
ARRAY_FLAG_FORMAT_VERSION_SHIFT = ARRAY_FLAG_FORMAT_VERSION_BASE,
348
// When changes are made to the mesh format, add a new version and use it for the CURRENT_VERSION.
349
ARRAY_FLAG_FORMAT_VERSION_1 = 0,
350
ARRAY_FLAG_FORMAT_VERSION_2 = 1ULL << ARRAY_FLAG_FORMAT_VERSION_SHIFT,
351
ARRAY_FLAG_FORMAT_CURRENT_VERSION = ARRAY_FLAG_FORMAT_VERSION_2,
352
ARRAY_FLAG_FORMAT_VERSION_MASK = 0xFF, // 8 bits version
353
};
354
355
static_assert(sizeof(ArrayFormat) == 8, "ArrayFormat should be 64 bits long.");
356
357
enum PrimitiveType {
358
PRIMITIVE_POINTS,
359
PRIMITIVE_LINES,
360
PRIMITIVE_LINE_STRIP,
361
PRIMITIVE_TRIANGLES,
362
PRIMITIVE_TRIANGLE_STRIP,
363
PRIMITIVE_MAX,
364
};
365
366
struct SurfaceData {
367
PrimitiveType primitive = PRIMITIVE_MAX;
368
369
uint64_t format = ARRAY_FLAG_FORMAT_CURRENT_VERSION;
370
Vector<uint8_t> vertex_data; // Vertex, Normal, Tangent (change with skinning, blendshape).
371
Vector<uint8_t> attribute_data; // Color, UV, UV2, Custom0-3.
372
Vector<uint8_t> skin_data; // Bone index, Bone weight.
373
uint32_t vertex_count = 0;
374
Vector<uint8_t> index_data;
375
uint32_t index_count = 0;
376
377
AABB aabb;
378
struct LOD {
379
float edge_length = 0.0f;
380
Vector<uint8_t> index_data;
381
};
382
Vector<LOD> lods;
383
Vector<AABB> bone_aabbs;
384
385
// Transforms used in runtime bone AABBs compute.
386
// Since bone AABBs is saved in Mesh space, but bones is in Skeleton space.
387
Transform3D mesh_to_skeleton_xform;
388
389
Vector<uint8_t> blend_shape_data;
390
391
Vector4 uv_scale;
392
393
RID material;
394
};
395
396
virtual RID mesh_create_from_surfaces(const Vector<SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;
397
virtual RID mesh_create() = 0;
398
399
virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;
400
401
virtual uint32_t mesh_surface_get_format_offset(BitField<ArrayFormat> p_format, int p_vertex_len, int p_array_index) const;
402
virtual uint32_t mesh_surface_get_format_vertex_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
403
virtual uint32_t mesh_surface_get_format_normal_tangent_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
404
virtual uint32_t mesh_surface_get_format_attribute_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
405
virtual uint32_t mesh_surface_get_format_skin_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
406
virtual uint32_t mesh_surface_get_format_index_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;
407
408
/// Returns stride
409
virtual void mesh_surface_make_offsets_from_format(uint64_t p_format, int p_vertex_len, int p_index_len, uint32_t *r_offsets, uint32_t &r_vertex_element_size, uint32_t &r_normal_element_size, uint32_t &r_attrib_element_size, uint32_t &r_skin_element_size) const;
410
virtual Error mesh_create_surface_data_from_arrays(SurfaceData *r_surface_data, PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), uint64_t p_compress_format = 0);
411
Array mesh_create_arrays_from_surface_data(const SurfaceData &p_data) const;
412
Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;
413
TypedArray<Array> mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;
414
Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;
415
416
virtual void mesh_add_surface_from_arrays(RID p_mesh, PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), BitField<ArrayFormat> p_compress_format = 0);
417
virtual void mesh_add_surface(RID p_mesh, const SurfaceData &p_surface) = 0;
418
419
virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;
420
421
enum BlendShapeMode {
422
BLEND_SHAPE_MODE_NORMALIZED,
423
BLEND_SHAPE_MODE_RELATIVE,
424
};
425
426
virtual void mesh_set_blend_shape_mode(RID p_mesh, BlendShapeMode p_mode) = 0;
427
virtual BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;
428
429
virtual void mesh_surface_update_vertex_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
430
virtual void mesh_surface_update_attribute_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
431
virtual void mesh_surface_update_skin_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
432
virtual void mesh_surface_update_index_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
433
434
virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;
435
virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;
436
437
virtual SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;
438
439
virtual int mesh_get_surface_count(RID p_mesh) const = 0;
440
441
virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
442
virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;
443
444
virtual void mesh_set_path(RID p_mesh, const String &p_path) = 0;
445
virtual String mesh_get_path(RID p_mesh) const = 0;
446
447
virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;
448
449
virtual void mesh_surface_remove(RID p_mesh, int p_surface) = 0;
450
virtual void mesh_clear(RID p_mesh) = 0;
451
452
struct MeshInfo {
453
RID mesh;
454
String path;
455
uint32_t vertex_buffer_size = 0;
456
uint32_t attribute_buffer_size = 0;
457
uint32_t skin_buffer_size = 0;
458
uint32_t index_buffer_size = 0;
459
uint32_t blend_shape_buffer_size = 0;
460
uint32_t lod_index_buffers_size = 0;
461
uint64_t vertex_count = 0;
462
};
463
464
virtual void mesh_debug_usage(List<MeshInfo> *r_info) = 0;
465
466
/* MULTIMESH API */
467
468
virtual RID multimesh_create() = 0;
469
470
enum MultimeshTransformFormat {
471
MULTIMESH_TRANSFORM_2D,
472
MULTIMESH_TRANSFORM_3D,
473
};
474
475
enum MultimeshPhysicsInterpolationQuality {
476
MULTIMESH_INTERP_QUALITY_FAST,
477
MULTIMESH_INTERP_QUALITY_HIGH,
478
};
479
480
protected:
481
#ifndef DISABLE_DEPRECATED
482
void _multimesh_allocate_data_bind_compat_99455(RID p_multimesh, int p_instances, MultimeshTransformFormat p_transform_format, bool p_use_colors, bool p_use_custom_data);
483
#endif
484
public:
485
virtual void multimesh_allocate_data(RID p_multimesh, int p_instances, MultimeshTransformFormat p_transform_format, bool p_use_colors = false, bool p_use_custom_data = false, bool p_use_indirect = false) = 0;
486
virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;
487
488
virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;
489
virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform3D &p_transform) = 0;
490
virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;
491
virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;
492
virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;
493
494
virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;
495
virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;
496
497
virtual void multimesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
498
virtual AABB multimesh_get_custom_aabb(RID p_mesh) const = 0;
499
500
virtual Transform3D multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;
501
virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;
502
virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;
503
virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;
504
505
virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;
506
virtual RID multimesh_get_command_buffer_rd_rid(RID p_multimesh) const = 0;
507
virtual RID multimesh_get_buffer_rd_rid(RID p_multimesh) const = 0;
508
virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;
509
510
// Interpolation.
511
virtual void multimesh_set_buffer_interpolated(RID p_multimesh, const Vector<float> &p_buffer_curr, const Vector<float> &p_buffer_prev) = 0;
512
virtual void multimesh_set_physics_interpolated(RID p_multimesh, bool p_interpolated) = 0;
513
virtual void multimesh_set_physics_interpolation_quality(RID p_multimesh, MultimeshPhysicsInterpolationQuality p_quality) = 0;
514
virtual void multimesh_instance_reset_physics_interpolation(RID p_multimesh, int p_index) = 0;
515
516
virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;
517
virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;
518
519
/* SKELETON API */
520
521
virtual RID skeleton_create() = 0;
522
virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;
523
virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;
524
virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform3D &p_transform) = 0;
525
virtual Transform3D skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;
526
virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;
527
virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;
528
virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;
529
530
/* Light API */
531
532
enum LightType {
533
LIGHT_DIRECTIONAL,
534
LIGHT_OMNI,
535
LIGHT_SPOT
536
};
537
538
enum LightParam {
539
LIGHT_PARAM_ENERGY,
540
LIGHT_PARAM_INDIRECT_ENERGY,
541
LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY,
542
LIGHT_PARAM_SPECULAR,
543
LIGHT_PARAM_RANGE,
544
LIGHT_PARAM_SIZE,
545
LIGHT_PARAM_ATTENUATION,
546
LIGHT_PARAM_SPOT_ANGLE,
547
LIGHT_PARAM_SPOT_ATTENUATION,
548
LIGHT_PARAM_SHADOW_MAX_DISTANCE,
549
LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,
550
LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,
551
LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,
552
LIGHT_PARAM_SHADOW_FADE_START,
553
LIGHT_PARAM_SHADOW_NORMAL_BIAS,
554
LIGHT_PARAM_SHADOW_BIAS,
555
LIGHT_PARAM_SHADOW_PANCAKE_SIZE,
556
LIGHT_PARAM_SHADOW_OPACITY,
557
LIGHT_PARAM_SHADOW_BLUR,
558
LIGHT_PARAM_TRANSMITTANCE_BIAS,
559
LIGHT_PARAM_INTENSITY,
560
LIGHT_PARAM_MAX
561
};
562
563
virtual RID directional_light_create() = 0;
564
virtual RID omni_light_create() = 0;
565
virtual RID spot_light_create() = 0;
566
567
virtual void light_set_color(RID p_light, const Color &p_color) = 0;
568
virtual void light_set_param(RID p_light, LightParam p_param, float p_value) = 0;
569
virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
570
virtual void light_set_projector(RID p_light, RID p_texture) = 0;
571
virtual void light_set_negative(RID p_light, bool p_enable) = 0;
572
virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
573
virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;
574
virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
575
virtual void light_set_shadow_caster_mask(RID p_light, uint32_t p_caster_mask) = 0;
576
577
enum LightBakeMode {
578
LIGHT_BAKE_DISABLED,
579
LIGHT_BAKE_STATIC,
580
LIGHT_BAKE_DYNAMIC,
581
};
582
583
virtual void light_set_bake_mode(RID p_light, LightBakeMode p_bake_mode) = 0;
584
virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
585
586
// Omni light
587
enum LightOmniShadowMode {
588
LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,
589
LIGHT_OMNI_SHADOW_CUBE,
590
};
591
592
virtual void light_omni_set_shadow_mode(RID p_light, LightOmniShadowMode p_mode) = 0;
593
594
// Directional light
595
enum LightDirectionalShadowMode {
596
LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,
597
LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,
598
LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS,
599
};
600
601
enum LightDirectionalSkyMode {
602
LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY,
603
LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY,
604
LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY,
605
};
606
607
virtual void light_directional_set_shadow_mode(RID p_light, LightDirectionalShadowMode p_mode) = 0;
608
virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
609
virtual void light_directional_set_sky_mode(RID p_light, LightDirectionalSkyMode p_mode) = 0;
610
611
// Shadow atlas
612
613
virtual RID shadow_atlas_create() = 0;
614
virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;
615
virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;
616
617
virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;
618
619
enum ShadowQuality {
620
SHADOW_QUALITY_HARD,
621
SHADOW_QUALITY_SOFT_VERY_LOW,
622
SHADOW_QUALITY_SOFT_LOW,
623
SHADOW_QUALITY_SOFT_MEDIUM,
624
SHADOW_QUALITY_SOFT_HIGH,
625
SHADOW_QUALITY_SOFT_ULTRA,
626
SHADOW_QUALITY_MAX
627
};
628
629
virtual void positional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;
630
virtual void directional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;
631
632
enum LightProjectorFilter {
633
LIGHT_PROJECTOR_FILTER_NEAREST,
634
LIGHT_PROJECTOR_FILTER_LINEAR,
635
LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS,
636
LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS,
637
LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,
638
LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,
639
};
640
641
virtual void light_projectors_set_filter(LightProjectorFilter p_filter) = 0;
642
643
/* PROBE API */
644
645
virtual RID reflection_probe_create() = 0;
646
647
enum ReflectionProbeUpdateMode {
648
REFLECTION_PROBE_UPDATE_ONCE,
649
REFLECTION_PROBE_UPDATE_ALWAYS,
650
};
651
652
virtual void reflection_probe_set_update_mode(RID p_probe, ReflectionProbeUpdateMode p_mode) = 0;
653
virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
654
virtual void reflection_probe_set_blend_distance(RID p_probe, float p_blend_distance) = 0;
655
656
enum ReflectionProbeAmbientMode {
657
REFLECTION_PROBE_AMBIENT_DISABLED,
658
REFLECTION_PROBE_AMBIENT_ENVIRONMENT,
659
REFLECTION_PROBE_AMBIENT_COLOR,
660
};
661
662
virtual void reflection_probe_set_ambient_mode(RID p_probe, ReflectionProbeAmbientMode p_mode) = 0;
663
virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
664
virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
665
virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
666
virtual void reflection_probe_set_size(RID p_probe, const Vector3 &p_size) = 0;
667
virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
668
virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
669
virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
670
virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
671
virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
672
virtual void reflection_probe_set_reflection_mask(RID p_probe, uint32_t p_layers) = 0;
673
virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
674
virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_pixels) = 0;
675
676
/* DECAL API */
677
678
enum DecalTexture {
679
DECAL_TEXTURE_ALBEDO,
680
DECAL_TEXTURE_NORMAL,
681
DECAL_TEXTURE_ORM,
682
DECAL_TEXTURE_EMISSION,
683
DECAL_TEXTURE_MAX
684
};
685
686
virtual RID decal_create() = 0;
687
virtual void decal_set_size(RID p_decal, const Vector3 &p_size) = 0;
688
virtual void decal_set_texture(RID p_decal, DecalTexture p_type, RID p_texture) = 0;
689
virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;
690
virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;
691
virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;
692
virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;
693
virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;
694
virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;
695
virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;
696
697
enum DecalFilter {
698
DECAL_FILTER_NEAREST,
699
DECAL_FILTER_LINEAR,
700
DECAL_FILTER_NEAREST_MIPMAPS,
701
DECAL_FILTER_LINEAR_MIPMAPS,
702
DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,
703
DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,
704
};
705
706
virtual void decals_set_filter(DecalFilter p_quality) = 0;
707
708
/* VOXEL GI API */
709
710
virtual RID voxel_gi_create() = 0;
711
712
virtual void voxel_gi_allocate_data(RID p_voxel_gi, const Transform3D &p_to_cell_xform, const AABB &p_aabb, const Vector3i &p_octree_size, const Vector<uint8_t> &p_octree_cells, const Vector<uint8_t> &p_data_cells, const Vector<uint8_t> &p_distance_field, const Vector<int> &p_level_counts) = 0;
713
714
virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;
715
virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;
716
virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;
717
virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;
718
virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;
719
virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;
720
virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;
721
722
virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;
723
virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;
724
virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;
725
virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;
726
virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;
727
virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;
728
virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;
729
virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;
730
731
enum VoxelGIQuality {
732
VOXEL_GI_QUALITY_LOW,
733
VOXEL_GI_QUALITY_HIGH,
734
};
735
736
virtual void voxel_gi_set_quality(VoxelGIQuality) = 0;
737
738
virtual void sdfgi_reset() = 0;
739
740
/* LIGHTMAP */
741
742
enum ShadowmaskMode {
743
SHADOWMASK_MODE_NONE,
744
SHADOWMASK_MODE_REPLACE,
745
SHADOWMASK_MODE_OVERLAY,
746
SHADOWMASK_MODE_ONLY,
747
};
748
749
virtual RID lightmap_create() = 0;
750
751
virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
752
virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
753
virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
754
virtual void lightmap_set_probe_capture_data(RID p_lightmap, const PackedVector3Array &p_points, const PackedColorArray &p_point_sh, const PackedInt32Array &p_tetrahedra, const PackedInt32Array &p_bsp_tree) = 0;
755
virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;
756
virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
757
virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
758
virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
759
virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
760
761
virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
762
virtual void lightmaps_set_bicubic_filter(bool p_enable) = 0;
763
764
virtual void lightmap_set_shadowmask_textures(RID p_lightmap, RID p_shadow) = 0;
765
virtual ShadowmaskMode lightmap_get_shadowmask_mode(RID p_lightmap) = 0;
766
virtual void lightmap_set_shadowmask_mode(RID p_lightmap, ShadowmaskMode p_mode) = 0;
767
768
/* PARTICLES API */
769
770
virtual RID particles_create() = 0;
771
772
enum ParticlesMode {
773
PARTICLES_MODE_2D,
774
PARTICLES_MODE_3D
775
};
776
virtual void particles_set_mode(RID p_particles, ParticlesMode p_mode) = 0;
777
778
virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;
779
virtual bool particles_get_emitting(RID p_particles) = 0;
780
virtual void particles_set_amount(RID p_particles, int p_amount) = 0;
781
virtual void particles_set_amount_ratio(RID p_particles, float p_amount_ratio) = 0;
782
virtual void particles_set_lifetime(RID p_particles, double p_lifetime) = 0;
783
virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;
784
virtual void particles_set_pre_process_time(RID p_particles, double p_time) = 0;
785
virtual void particles_request_process_time(RID p_particles, real_t p_request_process_time) = 0;
786
virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;
787
virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;
788
virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;
789
virtual void particles_set_speed_scale(RID p_particles, double p_scale) = 0;
790
virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;
791
virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;
792
virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;
793
virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;
794
virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;
795
virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;
796
virtual void particles_set_seed(RID p_particles, uint32_t p_seed) = 0;
797
798
enum ParticlesTransformAlign {
799
PARTICLES_TRANSFORM_ALIGN_DISABLED,
800
PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD,
801
PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY,
802
PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY,
803
};
804
805
virtual void particles_set_transform_align(RID p_particles, ParticlesTransformAlign p_transform_align) = 0;
806
807
virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;
808
virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) = 0;
809
810
virtual bool particles_is_inactive(RID p_particles) = 0;
811
virtual void particles_request_process(RID p_particles) = 0;
812
virtual void particles_restart(RID p_particles) = 0;
813
814
virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;
815
816
enum ParticlesEmitFlags {
817
PARTICLES_EMIT_FLAG_POSITION = 1,
818
PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2,
819
PARTICLES_EMIT_FLAG_VELOCITY = 4,
820
PARTICLES_EMIT_FLAG_COLOR = 8,
821
PARTICLES_EMIT_FLAG_CUSTOM = 16
822
};
823
824
virtual void particles_emit(RID p_particles, const Transform3D &p_transform, const Vector3 &p_velocity, const Color &p_color, const Color &p_custom, uint32_t p_emit_flags) = 0;
825
826
enum ParticlesDrawOrder {
827
PARTICLES_DRAW_ORDER_INDEX,
828
PARTICLES_DRAW_ORDER_LIFETIME,
829
PARTICLES_DRAW_ORDER_REVERSE_LIFETIME,
830
PARTICLES_DRAW_ORDER_VIEW_DEPTH,
831
};
832
833
virtual void particles_set_draw_order(RID p_particles, ParticlesDrawOrder p_order) = 0;
834
835
virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;
836
virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;
837
838
virtual AABB particles_get_current_aabb(RID p_particles) = 0;
839
840
virtual void particles_set_emission_transform(RID p_particles, const Transform3D &p_transform) = 0; // This is only used for 2D, in 3D it's automatic.
841
virtual void particles_set_emitter_velocity(RID p_particles, const Vector3 &p_velocity) = 0;
842
virtual void particles_set_interp_to_end(RID p_particles, float p_interp) = 0;
843
844
/* PARTICLES COLLISION API */
845
846
virtual RID particles_collision_create() = 0;
847
848
enum ParticlesCollisionType {
849
PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT,
850
PARTICLES_COLLISION_TYPE_BOX_ATTRACT,
851
PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT,
852
PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE,
853
PARTICLES_COLLISION_TYPE_BOX_COLLIDE,
854
PARTICLES_COLLISION_TYPE_SDF_COLLIDE,
855
PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE,
856
};
857
858
virtual void particles_collision_set_collision_type(RID p_particles_collision, ParticlesCollisionType p_type) = 0;
859
virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;
860
virtual void particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) = 0; // For spheres.
861
virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; // For non-spheres.
862
virtual void particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) = 0;
863
virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) = 0;
864
virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) = 0;
865
virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; // For SDF and vector field, heightfield is dynamic.
866
867
virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; // For SDF and vector field.
868
869
enum ParticlesCollisionHeightfieldResolution { // Longest axis resolution.
870
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256,
871
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512,
872
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024,
873
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048,
874
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096,
875
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192,
876
PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX,
877
};
878
879
virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, ParticlesCollisionHeightfieldResolution p_resolution) = 0; // For SDF and vector field.
880
virtual void particles_collision_set_height_field_mask(RID p_particles_collision, uint32_t p_heightfield_mask) = 0;
881
882
/* FOG VOLUME API */
883
884
virtual RID fog_volume_create() = 0;
885
886
enum FogVolumeShape {
887
FOG_VOLUME_SHAPE_ELLIPSOID,
888
FOG_VOLUME_SHAPE_CONE,
889
FOG_VOLUME_SHAPE_CYLINDER,
890
FOG_VOLUME_SHAPE_BOX,
891
FOG_VOLUME_SHAPE_WORLD,
892
FOG_VOLUME_SHAPE_MAX,
893
};
894
895
virtual void fog_volume_set_shape(RID p_fog_volume, FogVolumeShape p_shape) = 0;
896
virtual void fog_volume_set_size(RID p_fog_volume, const Vector3 &p_size) = 0;
897
virtual void fog_volume_set_material(RID p_fog_volume, RID p_material) = 0;
898
899
/* VISIBILITY NOTIFIER API */
900
901
virtual RID visibility_notifier_create() = 0;
902
virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) = 0;
903
virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
904
905
/* OCCLUDER API */
906
907
virtual RID occluder_create() = 0;
908
virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;
909
910
/* CAMERA API */
911
912
virtual RID camera_create() = 0;
913
virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;
914
virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;
915
virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;
916
virtual void camera_set_transform(RID p_camera, const Transform3D &p_transform) = 0;
917
virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;
918
virtual void camera_set_environment(RID p_camera, RID p_env) = 0;
919
virtual void camera_set_camera_attributes(RID p_camera, RID p_camera_attributes) = 0;
920
virtual void camera_set_compositor(RID p_camera, RID p_compositor) = 0;
921
virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;
922
923
/* VIEWPORT API */
924
925
enum CanvasItemTextureFilter {
926
CANVAS_ITEM_TEXTURE_FILTER_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.
927
CANVAS_ITEM_TEXTURE_FILTER_NEAREST,
928
CANVAS_ITEM_TEXTURE_FILTER_LINEAR,
929
CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS,
930
CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS,
931
CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC,
932
CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC,
933
CANVAS_ITEM_TEXTURE_FILTER_MAX
934
};
935
936
enum CanvasItemTextureRepeat {
937
CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.
938
CANVAS_ITEM_TEXTURE_REPEAT_DISABLED,
939
CANVAS_ITEM_TEXTURE_REPEAT_ENABLED,
940
CANVAS_ITEM_TEXTURE_REPEAT_MIRROR,
941
CANVAS_ITEM_TEXTURE_REPEAT_MAX,
942
};
943
944
virtual RID viewport_create() = 0;
945
946
enum ViewportScaling3DMode {
947
VIEWPORT_SCALING_3D_MODE_BILINEAR,
948
VIEWPORT_SCALING_3D_MODE_FSR,
949
VIEWPORT_SCALING_3D_MODE_FSR2,
950
VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL,
951
VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL,
952
VIEWPORT_SCALING_3D_MODE_MAX,
953
VIEWPORT_SCALING_3D_MODE_OFF = 255, // for internal use only
954
};
955
956
enum ViewportAnisotropicFiltering {
957
VIEWPORT_ANISOTROPY_DISABLED,
958
VIEWPORT_ANISOTROPY_2X,
959
VIEWPORT_ANISOTROPY_4X,
960
VIEWPORT_ANISOTROPY_8X,
961
VIEWPORT_ANISOTROPY_16X,
962
VIEWPORT_ANISOTROPY_MAX
963
};
964
965
enum ViewportScaling3DType {
966
VIEWPORT_SCALING_3D_TYPE_NONE,
967
VIEWPORT_SCALING_3D_TYPE_TEMPORAL,
968
VIEWPORT_SCALING_3D_TYPE_SPATIAL,
969
VIEWPORT_SCALING_3D_TYPE_MAX,
970
};
971
972
_ALWAYS_INLINE_ static ViewportScaling3DType scaling_3d_mode_type(ViewportScaling3DMode p_mode) {
973
if (p_mode == VIEWPORT_SCALING_3D_MODE_BILINEAR || p_mode == VIEWPORT_SCALING_3D_MODE_FSR || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL) {
974
return VIEWPORT_SCALING_3D_TYPE_SPATIAL;
975
} else if (p_mode == VIEWPORT_SCALING_3D_MODE_FSR2 || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL) {
976
return VIEWPORT_SCALING_3D_TYPE_TEMPORAL;
977
}
978
return VIEWPORT_SCALING_3D_TYPE_NONE;
979
}
980
981
virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;
982
virtual void viewport_set_size(RID p_viewport, int p_width, int p_height) = 0;
983
virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;
984
virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;
985
virtual void viewport_set_canvas_cull_mask(RID p_viewport, uint32_t p_canvas_cull_mask) = 0;
986
987
virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID) = 0;
988
virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;
989
990
virtual void viewport_set_scaling_3d_mode(RID p_viewport, ViewportScaling3DMode p_scaling_3d_mode) = 0;
991
virtual void viewport_set_scaling_3d_scale(RID p_viewport, float p_scaling_3d_scale) = 0;
992
virtual void viewport_set_fsr_sharpness(RID p_viewport, float p_fsr_sharpness) = 0;
993
virtual void viewport_set_texture_mipmap_bias(RID p_viewport, float p_texture_mipmap_bias) = 0;
994
virtual void viewport_set_anisotropic_filtering_level(RID p_viewport, ViewportAnisotropicFiltering p_anisotropic_filtering_level) = 0;
995
996
enum ViewportUpdateMode {
997
VIEWPORT_UPDATE_DISABLED,
998
VIEWPORT_UPDATE_ONCE, // Then goes to disabled, must be manually updated.
999
VIEWPORT_UPDATE_WHEN_VISIBLE, // Default
1000
VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE,
1001
VIEWPORT_UPDATE_ALWAYS
1002
};
1003
1004
virtual void viewport_set_update_mode(RID p_viewport, ViewportUpdateMode p_mode) = 0;
1005
virtual ViewportUpdateMode viewport_get_update_mode(RID p_viewport) const = 0;
1006
1007
enum ViewportClearMode {
1008
VIEWPORT_CLEAR_ALWAYS,
1009
VIEWPORT_CLEAR_NEVER,
1010
VIEWPORT_CLEAR_ONLY_NEXT_FRAME
1011
};
1012
1013
virtual void viewport_set_clear_mode(RID p_viewport, ViewportClearMode p_clear_mode) = 0;
1014
1015
virtual RID viewport_get_render_target(RID p_viewport) const = 0;
1016
virtual RID viewport_get_texture(RID p_viewport) const = 0;
1017
1018
enum ViewportEnvironmentMode {
1019
VIEWPORT_ENVIRONMENT_DISABLED,
1020
VIEWPORT_ENVIRONMENT_ENABLED,
1021
VIEWPORT_ENVIRONMENT_INHERIT,
1022
VIEWPORT_ENVIRONMENT_MAX,
1023
};
1024
1025
virtual void viewport_set_environment_mode(RID p_viewport, ViewportEnvironmentMode p_mode) = 0;
1026
virtual void viewport_set_disable_3d(RID p_viewport, bool p_disable) = 0;
1027
virtual void viewport_set_disable_2d(RID p_viewport, bool p_disable) = 0;
1028
1029
virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;
1030
virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;
1031
virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;
1032
virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;
1033
virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;
1034
virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;
1035
virtual void viewport_set_use_hdr_2d(RID p_viewport, bool p_use_hdr) = 0;
1036
virtual bool viewport_is_using_hdr_2d(RID p_viewport) const = 0;
1037
virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;
1038
virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;
1039
1040
virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, CanvasItemTextureFilter p_filter) = 0;
1041
virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, CanvasItemTextureRepeat p_repeat) = 0;
1042
1043
virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;
1044
virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;
1045
1046
enum ViewportSDFOversize {
1047
VIEWPORT_SDF_OVERSIZE_100_PERCENT,
1048
VIEWPORT_SDF_OVERSIZE_120_PERCENT,
1049
VIEWPORT_SDF_OVERSIZE_150_PERCENT,
1050
VIEWPORT_SDF_OVERSIZE_200_PERCENT,
1051
VIEWPORT_SDF_OVERSIZE_MAX
1052
};
1053
1054
enum ViewportSDFScale {
1055
VIEWPORT_SDF_SCALE_100_PERCENT,
1056
VIEWPORT_SDF_SCALE_50_PERCENT,
1057
VIEWPORT_SDF_SCALE_25_PERCENT,
1058
VIEWPORT_SDF_SCALE_MAX
1059
};
1060
1061
virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, ViewportSDFOversize p_oversize, ViewportSDFScale p_scale) = 0;
1062
1063
virtual void viewport_set_positional_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = true) = 0;
1064
virtual void viewport_set_positional_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;
1065
1066
enum ViewportMSAA {
1067
VIEWPORT_MSAA_DISABLED,
1068
VIEWPORT_MSAA_2X,
1069
VIEWPORT_MSAA_4X,
1070
VIEWPORT_MSAA_8X,
1071
VIEWPORT_MSAA_MAX,
1072
};
1073
1074
virtual void viewport_set_msaa_3d(RID p_viewport, ViewportMSAA p_msaa) = 0;
1075
virtual void viewport_set_msaa_2d(RID p_viewport, ViewportMSAA p_msaa) = 0;
1076
1077
enum ViewportScreenSpaceAA {
1078
VIEWPORT_SCREEN_SPACE_AA_DISABLED,
1079
VIEWPORT_SCREEN_SPACE_AA_FXAA,
1080
VIEWPORT_SCREEN_SPACE_AA_SMAA,
1081
VIEWPORT_SCREEN_SPACE_AA_MAX,
1082
};
1083
1084
virtual void viewport_set_screen_space_aa(RID p_viewport, ViewportScreenSpaceAA p_mode) = 0;
1085
1086
virtual void viewport_set_use_taa(RID p_viewport, bool p_use_taa) = 0;
1087
1088
virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;
1089
1090
virtual void viewport_set_force_motion_vectors(RID p_viewport, bool p_force_motion_vectors) = 0;
1091
1092
virtual void viewport_set_mesh_lod_threshold(RID p_viewport, float p_pixels) = 0;
1093
1094
virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling) = 0;
1095
virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;
1096
1097
enum ViewportOcclusionCullingBuildQuality {
1098
VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0,
1099
VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1,
1100
VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2,
1101
};
1102
1103
virtual void viewport_set_occlusion_culling_build_quality(ViewportOcclusionCullingBuildQuality p_quality) = 0;
1104
1105
enum ViewportRenderInfo {
1106
VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME,
1107
VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME,
1108
VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME,
1109
VIEWPORT_RENDER_INFO_MAX,
1110
};
1111
1112
enum ViewportRenderInfoType {
1113
VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
1114
VIEWPORT_RENDER_INFO_TYPE_SHADOW,
1115
VIEWPORT_RENDER_INFO_TYPE_CANVAS,
1116
VIEWPORT_RENDER_INFO_TYPE_MAX
1117
};
1118
1119
virtual int viewport_get_render_info(RID p_viewport, ViewportRenderInfoType p_type, ViewportRenderInfo p_info) = 0;
1120
1121
enum ViewportDebugDraw {
1122
VIEWPORT_DEBUG_DRAW_DISABLED,
1123
VIEWPORT_DEBUG_DRAW_UNSHADED,
1124
VIEWPORT_DEBUG_DRAW_LIGHTING,
1125
VIEWPORT_DEBUG_DRAW_OVERDRAW,
1126
VIEWPORT_DEBUG_DRAW_WIREFRAME,
1127
VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER,
1128
VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO,
1129
VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING,
1130
VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION,
1131
VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS,
1132
VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS,
1133
VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE,
1134
VIEWPORT_DEBUG_DRAW_SSAO,
1135
VIEWPORT_DEBUG_DRAW_SSIL,
1136
VIEWPORT_DEBUG_DRAW_PSSM_SPLITS,
1137
VIEWPORT_DEBUG_DRAW_DECAL_ATLAS,
1138
VIEWPORT_DEBUG_DRAW_SDFGI,
1139
VIEWPORT_DEBUG_DRAW_SDFGI_PROBES,
1140
VIEWPORT_DEBUG_DRAW_GI_BUFFER,
1141
VIEWPORT_DEBUG_DRAW_DISABLE_LOD,
1142
VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS,
1143
VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS,
1144
VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS,
1145
VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES,
1146
VIEWPORT_DEBUG_DRAW_OCCLUDERS,
1147
VIEWPORT_DEBUG_DRAW_MOTION_VECTORS,
1148
VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER,
1149
};
1150
1151
virtual void viewport_set_debug_draw(RID p_viewport, ViewportDebugDraw p_draw) = 0;
1152
1153
virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;
1154
virtual double viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;
1155
virtual double viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;
1156
1157
virtual RID viewport_find_from_screen_attachment(DisplayServer::WindowID p_id = DisplayServer::MAIN_WINDOW_ID) const = 0;
1158
1159
enum ViewportVRSMode {
1160
VIEWPORT_VRS_DISABLED,
1161
VIEWPORT_VRS_TEXTURE,
1162
VIEWPORT_VRS_XR,
1163
VIEWPORT_VRS_MAX,
1164
};
1165
1166
enum ViewportVRSUpdateMode {
1167
VIEWPORT_VRS_UPDATE_DISABLED,
1168
VIEWPORT_VRS_UPDATE_ONCE,
1169
VIEWPORT_VRS_UPDATE_ALWAYS,
1170
VIEWPORT_VRS_UPDATE_MAX,
1171
};
1172
1173
virtual void viewport_set_vrs_mode(RID p_viewport, ViewportVRSMode p_mode) = 0;
1174
virtual void viewport_set_vrs_update_mode(RID p_viewport, ViewportVRSUpdateMode p_mode) = 0;
1175
virtual void viewport_set_vrs_texture(RID p_viewport, RID p_texture) = 0;
1176
1177
/* SKY API */
1178
1179
enum SkyMode {
1180
SKY_MODE_AUTOMATIC,
1181
SKY_MODE_QUALITY,
1182
SKY_MODE_INCREMENTAL,
1183
SKY_MODE_REALTIME
1184
};
1185
1186
virtual RID sky_create() = 0;
1187
virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;
1188
virtual void sky_set_mode(RID p_sky, SkyMode p_mode) = 0;
1189
virtual void sky_set_material(RID p_sky, RID p_material) = 0;
1190
virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;
1191
1192
/* COMPOSITOR EFFECTS API */
1193
1194
enum CompositorEffectFlags {
1195
COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR = 1,
1196
COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH = 2,
1197
COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS = 4,
1198
COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS = 8,
1199
COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR = 16,
1200
};
1201
1202
enum CompositorEffectCallbackType {
1203
COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE,
1204
COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE,
1205
COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY,
1206
COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT,
1207
COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT,
1208
COMPOSITOR_EFFECT_CALLBACK_TYPE_MAX,
1209
COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY = -1,
1210
};
1211
1212
virtual RID compositor_effect_create() = 0;
1213
virtual void compositor_effect_set_enabled(RID p_effect, bool p_enabled) = 0;
1214
virtual void compositor_effect_set_callback(RID p_effect, CompositorEffectCallbackType p_callback_type, const Callable &p_callback) = 0;
1215
virtual void compositor_effect_set_flag(RID p_effect, CompositorEffectFlags p_flag, bool p_set) = 0;
1216
1217
/* COMPOSITOR API */
1218
1219
virtual RID compositor_create() = 0;
1220
1221
virtual void compositor_set_compositor_effects(RID p_compositor, const TypedArray<RID> &p_effects) = 0;
1222
1223
/* ENVIRONMENT API */
1224
1225
virtual RID environment_create() = 0;
1226
1227
enum EnvironmentBG {
1228
ENV_BG_CLEAR_COLOR,
1229
ENV_BG_COLOR,
1230
ENV_BG_SKY,
1231
ENV_BG_CANVAS,
1232
ENV_BG_KEEP,
1233
ENV_BG_CAMERA_FEED,
1234
ENV_BG_MAX
1235
};
1236
1237
enum EnvironmentAmbientSource {
1238
ENV_AMBIENT_SOURCE_BG,
1239
ENV_AMBIENT_SOURCE_DISABLED,
1240
ENV_AMBIENT_SOURCE_COLOR,
1241
ENV_AMBIENT_SOURCE_SKY,
1242
};
1243
1244
enum EnvironmentReflectionSource {
1245
ENV_REFLECTION_SOURCE_BG,
1246
ENV_REFLECTION_SOURCE_DISABLED,
1247
ENV_REFLECTION_SOURCE_SKY,
1248
};
1249
1250
virtual void environment_set_background(RID p_env, EnvironmentBG p_bg) = 0;
1251
virtual void environment_set_sky(RID p_env, RID p_sky) = 0;
1252
virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;
1253
virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;
1254
virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;
1255
virtual void environment_set_bg_energy(RID p_env, float p_multiplier, float p_exposure_value) = 0;
1256
virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;
1257
virtual void environment_set_ambient_light(RID p_env, const Color &p_color, EnvironmentAmbientSource p_ambient = ENV_AMBIENT_SOURCE_BG, float p_energy = 1.0, float p_sky_contribution = 0.0, EnvironmentReflectionSource p_reflection_source = ENV_REFLECTION_SOURCE_BG) = 0;
1258
virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;
1259
1260
enum EnvironmentGlowBlendMode {
1261
ENV_GLOW_BLEND_MODE_ADDITIVE,
1262
ENV_GLOW_BLEND_MODE_SCREEN,
1263
ENV_GLOW_BLEND_MODE_SOFTLIGHT,
1264
ENV_GLOW_BLEND_MODE_REPLACE,
1265
ENV_GLOW_BLEND_MODE_MIX,
1266
};
1267
1268
virtual void environment_set_glow(RID p_env, bool p_enable, Vector<float> p_levels, float p_intensity, float p_strength, float p_mix, float p_bloom_threshold, EnvironmentGlowBlendMode p_blend_mode, float p_hdr_bleed_threshold, float p_hdr_bleed_scale, float p_hdr_luminance_cap, float p_glow_map_strength, RID p_glow_map) = 0;
1269
1270
virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;
1271
1272
enum EnvironmentToneMapper {
1273
ENV_TONE_MAPPER_LINEAR,
1274
ENV_TONE_MAPPER_REINHARD,
1275
ENV_TONE_MAPPER_FILMIC,
1276
ENV_TONE_MAPPER_ACES,
1277
ENV_TONE_MAPPER_AGX,
1278
};
1279
1280
virtual void environment_set_tonemap(RID p_env, EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white) = 0;
1281
virtual void environment_set_adjustment(RID p_env, bool p_enable, float p_brightness, float p_contrast, float p_saturation, bool p_use_1d_color_correction, RID p_color_correction) = 0;
1282
1283
virtual void environment_set_ssr(RID p_env, bool p_enable, int p_max_steps, float p_fade_in, float p_fade_out, float p_depth_tolerance) = 0;
1284
1285
enum EnvironmentSSRRoughnessQuality {
1286
ENV_SSR_ROUGHNESS_QUALITY_DISABLED,
1287
ENV_SSR_ROUGHNESS_QUALITY_LOW,
1288
ENV_SSR_ROUGHNESS_QUALITY_MEDIUM,
1289
ENV_SSR_ROUGHNESS_QUALITY_HIGH,
1290
};
1291
1292
virtual void environment_set_ssr_roughness_quality(EnvironmentSSRRoughnessQuality p_quality) = 0;
1293
1294
virtual void environment_set_ssao(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_power, float p_detail, float p_horizon, float p_sharpness, float p_light_affect, float p_ao_channel_affect) = 0;
1295
1296
enum EnvironmentSSAOQuality {
1297
ENV_SSAO_QUALITY_VERY_LOW,
1298
ENV_SSAO_QUALITY_LOW,
1299
ENV_SSAO_QUALITY_MEDIUM,
1300
ENV_SSAO_QUALITY_HIGH,
1301
ENV_SSAO_QUALITY_ULTRA,
1302
};
1303
1304
virtual void environment_set_ssao_quality(EnvironmentSSAOQuality p_quality, bool p_half_size, float p_adaptive_target, int p_blur_passes, float p_fadeout_from, float p_fadeout_to) = 0;
1305
1306
virtual void environment_set_ssil(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_sharpness, float p_normal_rejection) = 0;
1307
1308
enum EnvironmentSSILQuality {
1309
ENV_SSIL_QUALITY_VERY_LOW,
1310
ENV_SSIL_QUALITY_LOW,
1311
ENV_SSIL_QUALITY_MEDIUM,
1312
ENV_SSIL_QUALITY_HIGH,
1313
ENV_SSIL_QUALITY_ULTRA,
1314
};
1315
1316
virtual void environment_set_ssil_quality(EnvironmentSSILQuality p_quality, bool p_half_size, float p_adaptive_target, int p_blur_passes, float p_fadeout_from, float p_fadeout_to) = 0;
1317
1318
enum EnvironmentSDFGIYScale {
1319
ENV_SDFGI_Y_SCALE_50_PERCENT,
1320
ENV_SDFGI_Y_SCALE_75_PERCENT,
1321
ENV_SDFGI_Y_SCALE_100_PERCENT,
1322
};
1323
1324
virtual void environment_set_sdfgi(RID p_env, bool p_enable, int p_cascades, float p_min_cell_size, EnvironmentSDFGIYScale p_y_scale, bool p_use_occlusion, float p_bounce_feedback, bool p_read_sky, float p_energy, float p_normal_bias, float p_probe_bias) = 0;
1325
1326
enum EnvironmentSDFGIRayCount {
1327
ENV_SDFGI_RAY_COUNT_4,
1328
ENV_SDFGI_RAY_COUNT_8,
1329
ENV_SDFGI_RAY_COUNT_16,
1330
ENV_SDFGI_RAY_COUNT_32,
1331
ENV_SDFGI_RAY_COUNT_64,
1332
ENV_SDFGI_RAY_COUNT_96,
1333
ENV_SDFGI_RAY_COUNT_128,
1334
ENV_SDFGI_RAY_COUNT_MAX,
1335
};
1336
1337
virtual void environment_set_sdfgi_ray_count(EnvironmentSDFGIRayCount p_ray_count) = 0;
1338
1339
enum EnvironmentSDFGIFramesToConverge {
1340
ENV_SDFGI_CONVERGE_IN_5_FRAMES,
1341
ENV_SDFGI_CONVERGE_IN_10_FRAMES,
1342
ENV_SDFGI_CONVERGE_IN_15_FRAMES,
1343
ENV_SDFGI_CONVERGE_IN_20_FRAMES,
1344
ENV_SDFGI_CONVERGE_IN_25_FRAMES,
1345
ENV_SDFGI_CONVERGE_IN_30_FRAMES,
1346
ENV_SDFGI_CONVERGE_MAX
1347
};
1348
1349
virtual void environment_set_sdfgi_frames_to_converge(EnvironmentSDFGIFramesToConverge p_frames) = 0;
1350
1351
enum EnvironmentSDFGIFramesToUpdateLight {
1352
ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME,
1353
ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES,
1354
ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES,
1355
ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES,
1356
ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES,
1357
ENV_SDFGI_UPDATE_LIGHT_MAX,
1358
};
1359
1360
virtual void environment_set_sdfgi_frames_to_update_light(EnvironmentSDFGIFramesToUpdateLight p_update) = 0;
1361
1362
enum EnvironmentFogMode {
1363
ENV_FOG_MODE_EXPONENTIAL,
1364
ENV_FOG_MODE_DEPTH,
1365
};
1366
1367
virtual void environment_set_fog(RID p_env, bool p_enable, const Color &p_light_color, float p_light_energy, float p_sun_scatter, float p_density, float p_height, float p_height_density, float p_aerial_perspective, float p_sky_affect, EnvironmentFogMode p_mode = EnvironmentFogMode::ENV_FOG_MODE_EXPONENTIAL) = 0;
1368
virtual void environment_set_fog_depth(RID p_env, float p_curve, float p_begin, float p_end) = 0;
1369
1370
virtual void environment_set_volumetric_fog(RID p_env, bool p_enable, float p_density, const Color &p_albedo, const Color &p_emission, float p_emission_energy, float p_anisotropy, float p_length, float p_detail_spread, float p_gi_inject, bool p_temporal_reprojection, float p_temporal_reprojection_amount, float p_ambient_inject, float p_sky_affect) = 0;
1371
virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;
1372
virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;
1373
1374
virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;
1375
1376
virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;
1377
1378
enum SubSurfaceScatteringQuality {
1379
SUB_SURFACE_SCATTERING_QUALITY_DISABLED,
1380
SUB_SURFACE_SCATTERING_QUALITY_LOW,
1381
SUB_SURFACE_SCATTERING_QUALITY_MEDIUM,
1382
SUB_SURFACE_SCATTERING_QUALITY_HIGH,
1383
};
1384
1385
virtual void sub_surface_scattering_set_quality(SubSurfaceScatteringQuality p_quality) = 0;
1386
virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;
1387
1388
/* CAMERA EFFECTS */
1389
1390
virtual RID camera_attributes_create() = 0;
1391
1392
enum DOFBlurQuality {
1393
DOF_BLUR_QUALITY_VERY_LOW,
1394
DOF_BLUR_QUALITY_LOW,
1395
DOF_BLUR_QUALITY_MEDIUM,
1396
DOF_BLUR_QUALITY_HIGH,
1397
};
1398
1399
virtual void camera_attributes_set_dof_blur_quality(DOFBlurQuality p_quality, bool p_use_jitter) = 0;
1400
1401
enum DOFBokehShape {
1402
DOF_BOKEH_BOX,
1403
DOF_BOKEH_HEXAGON,
1404
DOF_BOKEH_CIRCLE
1405
};
1406
1407
virtual void camera_attributes_set_dof_blur_bokeh_shape(DOFBokehShape p_shape) = 0;
1408
1409
virtual void camera_attributes_set_dof_blur(RID p_camera_attributes, bool p_far_enable, float p_far_distance, float p_far_transition, bool p_near_enable, float p_near_distance, float p_near_transition, float p_amount) = 0;
1410
virtual void camera_attributes_set_exposure(RID p_camera_attributes, float p_multiplier, float p_exposure_normalization) = 0;
1411
virtual void camera_attributes_set_auto_exposure(RID p_camera_attributes, bool p_enable, float p_min_sensitivity, float p_max_sensitivity, float p_speed, float p_scale) = 0;
1412
1413
/* SCENARIO API */
1414
1415
virtual RID scenario_create() = 0;
1416
1417
virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;
1418
virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;
1419
virtual void scenario_set_camera_attributes(RID p_scenario, RID p_camera_attributes) = 0;
1420
virtual void scenario_set_compositor(RID p_scenario, RID p_compositor) = 0;
1421
1422
/* INSTANCING API */
1423
1424
enum InstanceType {
1425
INSTANCE_NONE,
1426
INSTANCE_MESH,
1427
INSTANCE_MULTIMESH,
1428
INSTANCE_PARTICLES,
1429
INSTANCE_PARTICLES_COLLISION,
1430
INSTANCE_LIGHT,
1431
INSTANCE_REFLECTION_PROBE,
1432
INSTANCE_DECAL,
1433
INSTANCE_VOXEL_GI,
1434
INSTANCE_LIGHTMAP,
1435
INSTANCE_OCCLUDER,
1436
INSTANCE_VISIBLITY_NOTIFIER, // TODO: Fix typo in "VISIBILITY" (in 5.0).
1437
INSTANCE_FOG_VOLUME,
1438
INSTANCE_MAX,
1439
1440
INSTANCE_GEOMETRY_MASK = (1 << INSTANCE_MESH) | (1 << INSTANCE_MULTIMESH) | (1 << INSTANCE_PARTICLES)
1441
};
1442
1443
virtual RID instance_create2(RID p_base, RID p_scenario);
1444
1445
virtual RID instance_create() = 0;
1446
1447
virtual void instance_set_base(RID p_instance, RID p_base) = 0;
1448
virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;
1449
virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;
1450
virtual void instance_set_pivot_data(RID p_instance, float p_sorting_offset, bool p_use_aabb_center) = 0;
1451
virtual void instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;
1452
virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;
1453
virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;
1454
virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;
1455
virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;
1456
1457
virtual void instance_teleport(RID p_instance) = 0;
1458
1459
virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;
1460
1461
virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;
1462
1463
virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;
1464
virtual void instance_set_visibility_parent(RID p_instance, RID p_parent_instance) = 0;
1465
1466
virtual void instance_set_ignore_culling(RID p_instance, bool p_enabled) = 0;
1467
1468
// Don't use these in a game!
1469
virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;
1470
virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;
1471
virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;
1472
1473
PackedInt64Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;
1474
PackedInt64Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;
1475
PackedInt64Array _instances_cull_convex_bind(const TypedArray<Plane> &p_convex, RID p_scenario = RID()) const;
1476
1477
enum InstanceFlags {
1478
INSTANCE_FLAG_USE_BAKED_LIGHT,
1479
INSTANCE_FLAG_USE_DYNAMIC_GI,
1480
INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE,
1481
INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING,
1482
INSTANCE_FLAG_MAX
1483
};
1484
1485
enum ShadowCastingSetting {
1486
SHADOW_CASTING_SETTING_OFF,
1487
SHADOW_CASTING_SETTING_ON,
1488
SHADOW_CASTING_SETTING_DOUBLE_SIDED,
1489
SHADOW_CASTING_SETTING_SHADOWS_ONLY,
1490
};
1491
1492
enum VisibilityRangeFadeMode {
1493
VISIBILITY_RANGE_FADE_DISABLED,
1494
VISIBILITY_RANGE_FADE_SELF,
1495
VISIBILITY_RANGE_FADE_DEPENDENCIES,
1496
};
1497
1498
virtual void instance_geometry_set_flag(RID p_instance, InstanceFlags p_flags, bool p_enabled) = 0;
1499
virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, ShadowCastingSetting p_shadow_casting_setting) = 0;
1500
virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;
1501
virtual void instance_geometry_set_material_overlay(RID p_instance, RID p_material) = 0;
1502
virtual void instance_geometry_set_visibility_range(RID p_instance, float p_min, float p_max, float p_min_margin, float p_max_margin, VisibilityRangeFadeMode p_fade_mode) = 0;
1503
virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;
1504
virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;
1505
virtual void instance_geometry_set_transparency(RID p_instance, float p_transparency) = 0;
1506
1507
virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;
1508
virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;
1509
virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;
1510
virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;
1511
1512
/* Bake 3D objects */
1513
1514
enum BakeChannels {
1515
BAKE_CHANNEL_ALBEDO_ALPHA,
1516
BAKE_CHANNEL_NORMAL,
1517
BAKE_CHANNEL_ORM,
1518
BAKE_CHANNEL_EMISSION
1519
};
1520
1521
virtual TypedArray<Image> bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size) = 0;
1522
1523
/* CANVAS (2D) */
1524
1525
virtual RID canvas_create() = 0;
1526
virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;
1527
virtual void canvas_set_item_repeat(RID p_item, const Point2 &p_repeat_size, int p_repeat_times) = 0;
1528
virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;
1529
virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;
1530
1531
virtual void canvas_set_disable_scale(bool p_disable) = 0;
1532
1533
/* CANVAS TEXTURE */
1534
virtual RID canvas_texture_create() = 0;
1535
1536
enum CanvasTextureChannel {
1537
CANVAS_TEXTURE_CHANNEL_DIFFUSE,
1538
CANVAS_TEXTURE_CHANNEL_NORMAL,
1539
CANVAS_TEXTURE_CHANNEL_SPECULAR,
1540
};
1541
virtual void canvas_texture_set_channel(RID p_canvas_texture, CanvasTextureChannel p_channel, RID p_texture) = 0;
1542
virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;
1543
1544
// Takes effect only for new draw commands.
1545
virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, CanvasItemTextureFilter p_filter) = 0;
1546
virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, CanvasItemTextureRepeat p_repeat) = 0;
1547
1548
/* CANVAS ITEM */
1549
1550
virtual RID canvas_item_create() = 0;
1551
virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;
1552
1553
virtual void canvas_item_set_default_texture_filter(RID p_item, CanvasItemTextureFilter p_filter) = 0;
1554
virtual void canvas_item_set_default_texture_repeat(RID p_item, CanvasItemTextureRepeat p_repeat) = 0;
1555
1556
virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;
1557
virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;
1558
1559
virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;
1560
1561
virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;
1562
virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;
1563
virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;
1564
virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;
1565
virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;
1566
virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;
1567
virtual void canvas_item_set_visibility_layer(RID p_item, uint32_t p_visibility_layer) = 0;
1568
1569
virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;
1570
virtual void canvas_item_set_use_identity_transform(RID p_item, bool p_enabled) = 0;
1571
1572
enum NinePatchAxisMode {
1573
NINE_PATCH_STRETCH,
1574
NINE_PATCH_TILE,
1575
NINE_PATCH_TILE_FIT,
1576
};
1577
1578
virtual void canvas_item_add_line(RID p_item, const Point2 &p_from, const Point2 &p_to, const Color &p_color, float p_width = -1.0, bool p_antialiased = false) = 0;
1579
virtual void canvas_item_add_polyline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0, bool p_antialiased = false) = 0;
1580
virtual void canvas_item_add_multiline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0, bool p_antialiased = false) = 0;
1581
virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color, bool p_antialiased = false) = 0;
1582
virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color, bool p_antialiased = false) = 0;
1583
virtual void canvas_item_add_texture_rect(RID p_item, const Rect2 &p_rect, RID p_texture, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false) = 0;
1584
virtual void canvas_item_add_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, bool p_clip_uv = false) = 0;
1585
virtual void canvas_item_add_msdf_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), int p_outline_size = 0, float p_px_range = 1.0, float p_scale = 1.0) = 0;
1586
virtual void canvas_item_add_lcd_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1)) = 0;
1587
virtual void canvas_item_add_nine_patch(RID p_item, const Rect2 &p_rect, const Rect2 &p_source, RID p_texture, const Vector2 &p_topleft, const Vector2 &p_bottomright, NinePatchAxisMode p_x_axis_mode = NINE_PATCH_STRETCH, NinePatchAxisMode p_y_axis_mode = NINE_PATCH_STRETCH, bool p_draw_center = true, const Color &p_modulate = Color(1, 1, 1)) = 0;
1588
virtual void canvas_item_add_primitive(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs, RID p_texture) = 0;
1589
virtual void canvas_item_add_polygon(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs = Vector<Point2>(), RID p_texture = RID()) = 0;
1590
virtual void canvas_item_add_triangle_array(RID p_item, const Vector<int> &p_indices, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs = Vector<Point2>(), const Vector<int> &p_bones = Vector<int>(), const Vector<float> &p_weights = Vector<float>(), RID p_texture = RID(), int p_count = -1) = 0;
1591
virtual void canvas_item_add_mesh(RID p_item, const RID &p_mesh, const Transform2D &p_transform = Transform2D(), const Color &p_modulate = Color(1, 1, 1), RID p_texture = RID()) = 0;
1592
virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;
1593
virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;
1594
virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;
1595
virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;
1596
virtual void canvas_item_add_animation_slice(RID p_item, double p_animation_length, double p_slice_begin, double p_slice_end, double p_offset) = 0;
1597
1598
virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;
1599
virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;
1600
virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;
1601
virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;
1602
1603
virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;
1604
1605
virtual void canvas_item_clear(RID p_item) = 0;
1606
virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;
1607
1608
virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;
1609
1610
virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;
1611
1612
virtual void canvas_item_set_instance_shader_parameter(RID p_item, const StringName &, const Variant &p_value) = 0;
1613
virtual Variant canvas_item_get_instance_shader_parameter(RID p_item, const StringName &) const = 0;
1614
virtual Variant canvas_item_get_instance_shader_parameter_default_value(RID p_item, const StringName &) const = 0;
1615
virtual void canvas_item_get_instance_shader_parameter_list(RID p_item, List<PropertyInfo> *p_parameters) const = 0;
1616
1617
virtual void canvas_item_set_visibility_notifier(RID p_item, bool p_enable, const Rect2 &p_area, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
1618
1619
enum CanvasGroupMode {
1620
CANVAS_GROUP_MODE_DISABLED,
1621
CANVAS_GROUP_MODE_CLIP_ONLY,
1622
CANVAS_GROUP_MODE_CLIP_AND_DRAW,
1623
CANVAS_GROUP_MODE_TRANSPARENT,
1624
};
1625
1626
virtual void canvas_item_set_canvas_group_mode(RID p_item, CanvasGroupMode p_mode, float p_clear_margin = 5.0, bool p_fit_empty = false, float p_fit_margin = 0.0, bool p_blur_mipmaps = false) = 0;
1627
1628
virtual void canvas_item_set_debug_redraw(bool p_enabled) = 0;
1629
virtual bool canvas_item_get_debug_redraw() const = 0;
1630
1631
virtual void canvas_item_set_interpolated(RID p_item, bool p_interpolated) = 0;
1632
virtual void canvas_item_reset_physics_interpolation(RID p_item) = 0;
1633
virtual void canvas_item_transform_physics_interpolation(RID p_item, const Transform2D &p_transform) = 0;
1634
1635
/* CANVAS LIGHT */
1636
virtual RID canvas_light_create() = 0;
1637
1638
enum CanvasLightMode {
1639
CANVAS_LIGHT_MODE_POINT,
1640
CANVAS_LIGHT_MODE_DIRECTIONAL,
1641
};
1642
1643
virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode) = 0;
1644
1645
virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;
1646
virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;
1647
virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;
1648
virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;
1649
virtual void canvas_light_set_height(RID p_light, float p_height) = 0;
1650
virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;
1651
virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;
1652
virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;
1653
virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;
1654
virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;
1655
1656
virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;
1657
1658
virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;
1659
virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;
1660
virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;
1661
1662
enum CanvasLightBlendMode {
1663
CANVAS_LIGHT_BLEND_MODE_ADD,
1664
CANVAS_LIGHT_BLEND_MODE_SUB,
1665
CANVAS_LIGHT_BLEND_MODE_MIX,
1666
};
1667
1668
virtual void canvas_light_set_blend_mode(RID p_light, CanvasLightBlendMode p_mode) = 0;
1669
1670
enum CanvasLightShadowFilter {
1671
CANVAS_LIGHT_FILTER_NONE,
1672
CANVAS_LIGHT_FILTER_PCF5,
1673
CANVAS_LIGHT_FILTER_PCF13,
1674
CANVAS_LIGHT_FILTER_MAX
1675
};
1676
1677
virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;
1678
virtual void canvas_light_set_shadow_filter(RID p_light, CanvasLightShadowFilter p_filter) = 0;
1679
virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;
1680
virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;
1681
1682
virtual void canvas_light_set_interpolated(RID p_light, bool p_interpolated) = 0;
1683
virtual void canvas_light_reset_physics_interpolation(RID p_light) = 0;
1684
virtual void canvas_light_transform_physics_interpolation(RID p_light, const Transform2D &p_transform) = 0;
1685
1686
/* CANVAS LIGHT OCCLUDER */
1687
1688
virtual RID canvas_light_occluder_create() = 0;
1689
virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;
1690
virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;
1691
virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;
1692
virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;
1693
virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;
1694
virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;
1695
1696
virtual void canvas_light_occluder_set_interpolated(RID p_occluder, bool p_interpolated) = 0;
1697
virtual void canvas_light_occluder_reset_physics_interpolation(RID p_occluder) = 0;
1698
virtual void canvas_light_occluder_transform_physics_interpolation(RID p_occluder, const Transform2D &p_transform) = 0;
1699
1700
/* CANVAS LIGHT OCCLUDER POLYGON */
1701
1702
virtual RID canvas_occluder_polygon_create() = 0;
1703
virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;
1704
1705
enum CanvasOccluderPolygonCullMode {
1706
CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,
1707
CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,
1708
CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,
1709
};
1710
1711
virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, CanvasOccluderPolygonCullMode p_mode) = 0;
1712
1713
virtual void canvas_set_shadow_texture_size(int p_size) = 0;
1714
1715
Rect2 debug_canvas_item_get_rect(RID p_item);
1716
virtual Rect2 _debug_canvas_item_get_rect(RID p_item) = 0;
1717
1718
/* GLOBAL SHADER UNIFORMS */
1719
1720
enum GlobalShaderParameterType {
1721
GLOBAL_VAR_TYPE_BOOL,
1722
GLOBAL_VAR_TYPE_BVEC2,
1723
GLOBAL_VAR_TYPE_BVEC3,
1724
GLOBAL_VAR_TYPE_BVEC4,
1725
GLOBAL_VAR_TYPE_INT,
1726
GLOBAL_VAR_TYPE_IVEC2,
1727
GLOBAL_VAR_TYPE_IVEC3,
1728
GLOBAL_VAR_TYPE_IVEC4,
1729
GLOBAL_VAR_TYPE_RECT2I,
1730
GLOBAL_VAR_TYPE_UINT,
1731
GLOBAL_VAR_TYPE_UVEC2,
1732
GLOBAL_VAR_TYPE_UVEC3,
1733
GLOBAL_VAR_TYPE_UVEC4,
1734
GLOBAL_VAR_TYPE_FLOAT,
1735
GLOBAL_VAR_TYPE_VEC2,
1736
GLOBAL_VAR_TYPE_VEC3,
1737
GLOBAL_VAR_TYPE_VEC4,
1738
GLOBAL_VAR_TYPE_COLOR,
1739
GLOBAL_VAR_TYPE_RECT2,
1740
GLOBAL_VAR_TYPE_MAT2,
1741
GLOBAL_VAR_TYPE_MAT3,
1742
GLOBAL_VAR_TYPE_MAT4,
1743
GLOBAL_VAR_TYPE_TRANSFORM_2D,
1744
GLOBAL_VAR_TYPE_TRANSFORM,
1745
GLOBAL_VAR_TYPE_SAMPLER2D,
1746
GLOBAL_VAR_TYPE_SAMPLER2DARRAY,
1747
GLOBAL_VAR_TYPE_SAMPLER3D,
1748
GLOBAL_VAR_TYPE_SAMPLERCUBE,
1749
GLOBAL_VAR_TYPE_SAMPLEREXT,
1750
GLOBAL_VAR_TYPE_MAX
1751
};
1752
1753
virtual void global_shader_parameter_add(const StringName &p_name, GlobalShaderParameterType p_type, const Variant &p_value) = 0;
1754
virtual void global_shader_parameter_remove(const StringName &p_name) = 0;
1755
virtual Vector<StringName> global_shader_parameter_get_list() const = 0;
1756
1757
virtual void global_shader_parameter_set(const StringName &p_name, const Variant &p_value) = 0;
1758
virtual void global_shader_parameter_set_override(const StringName &p_name, const Variant &p_value) = 0;
1759
1760
virtual Variant global_shader_parameter_get(const StringName &p_name) const = 0;
1761
virtual GlobalShaderParameterType global_shader_parameter_get_type(const StringName &p_name) const = 0;
1762
1763
virtual void global_shader_parameters_load_settings(bool p_load_textures) = 0;
1764
virtual void global_shader_parameters_clear() = 0;
1765
1766
static int global_shader_uniform_type_get_shader_datatype(GlobalShaderParameterType p_type);
1767
1768
/* FREE */
1769
1770
virtual void free(RID p_rid) = 0; // Free RIDs associated with the rendering server.
1771
1772
/* INTERPOLATION */
1773
1774
virtual void set_physics_interpolation_enabled(bool p_enabled) = 0;
1775
1776
/* EVENT QUEUING */
1777
1778
virtual void request_frame_drawn_callback(const Callable &p_callable) = 0;
1779
1780
virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;
1781
virtual void sync() = 0;
1782
virtual bool has_changed() const = 0;
1783
virtual void init();
1784
virtual void finish() = 0;
1785
virtual void tick() = 0;
1786
virtual void pre_draw(bool p_will_draw) = 0;
1787
1788
/* STATUS INFORMATION */
1789
1790
enum RenderingInfo {
1791
RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME,
1792
RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME,
1793
RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME,
1794
RENDERING_INFO_TEXTURE_MEM_USED,
1795
RENDERING_INFO_BUFFER_MEM_USED,
1796
RENDERING_INFO_VIDEO_MEM_USED,
1797
RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS,
1798
RENDERING_INFO_PIPELINE_COMPILATIONS_MESH,
1799
RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE,
1800
RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW,
1801
RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION,
1802
RENDERING_INFO_MAX
1803
};
1804
1805
virtual uint64_t get_rendering_info(RenderingInfo p_info) = 0;
1806
virtual String get_video_adapter_name() const = 0;
1807
virtual String get_video_adapter_vendor() const = 0;
1808
virtual RenderingDevice::DeviceType get_video_adapter_type() const = 0;
1809
virtual String get_video_adapter_api_version() const = 0;
1810
1811
struct FrameProfileArea {
1812
String name;
1813
double gpu_msec;
1814
double cpu_msec;
1815
};
1816
1817
virtual void set_frame_profiling_enabled(bool p_enable) = 0;
1818
virtual Vector<FrameProfileArea> get_frame_profile() = 0;
1819
virtual uint64_t get_frame_profile_frame() = 0;
1820
1821
virtual double get_frame_setup_time_cpu() const = 0;
1822
1823
virtual void gi_set_use_half_resolution(bool p_enable) = 0;
1824
1825
/* TESTING */
1826
1827
virtual RID get_test_cube() = 0;
1828
1829
virtual RID get_test_texture();
1830
virtual RID get_white_texture();
1831
1832
virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;
1833
1834
virtual RID make_sphere_mesh(int p_lats, int p_lons, real_t p_radius);
1835
1836
virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);
1837
virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);
1838
1839
virtual void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true) = 0;
1840
virtual Color get_default_clear_color() = 0;
1841
virtual void set_default_clear_color(const Color &p_color) = 0;
1842
1843
#ifndef DISABLE_DEPRECATED
1844
// Never actually used, should be removed when we can break compatibility.
1845
enum Features {
1846
FEATURE_SHADERS,
1847
FEATURE_MULTITHREADED,
1848
};
1849
virtual bool has_feature(Features p_feature) const = 0;
1850
#endif
1851
virtual bool has_os_feature(const String &p_feature) const = 0;
1852
1853
virtual void set_debug_generate_wireframes(bool p_generate) = 0;
1854
1855
virtual void call_set_vsync_mode(DisplayServer::VSyncMode p_mode, DisplayServer::WindowID p_window) = 0;
1856
1857
virtual bool is_low_end() const = 0;
1858
1859
virtual void set_print_gpu_profile(bool p_enable) = 0;
1860
1861
virtual Size2i get_maximum_viewport_size() const = 0;
1862
1863
RenderingDevice *get_rendering_device() const;
1864
RenderingDevice *create_local_rendering_device() const;
1865
1866
bool is_render_loop_enabled() const;
1867
void set_render_loop_enabled(bool p_enabled);
1868
1869
virtual bool is_on_render_thread() = 0;
1870
virtual void call_on_render_thread(const Callable &p_callable) = 0;
1871
1872
String get_current_rendering_driver_name() const;
1873
String get_current_rendering_method() const;
1874
1875
#ifdef TOOLS_ENABLED
1876
virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const override;
1877
#endif
1878
1879
RenderingServer();
1880
virtual ~RenderingServer();
1881
1882
#ifdef TOOLS_ENABLED
1883
typedef void (*SurfaceUpgradeCallback)();
1884
void set_surface_upgrade_callback(SurfaceUpgradeCallback p_callback);
1885
void set_warn_on_surface_upgrade(bool p_warn);
1886
#endif
1887
1888
#ifndef DISABLE_DEPRECATED
1889
void fix_surface_compatibility(SurfaceData &p_surface, const String &p_path = "");
1890
#endif
1891
1892
private:
1893
// Binder helpers
1894
RID _texture_2d_layered_create(const TypedArray<Image> &p_layers, TextureLayeredType p_layered_type);
1895
RID _texture_3d_create(Image::Format p_format, int p_width, int p_height, int p_depth, bool p_mipmaps, const TypedArray<Image> &p_data);
1896
void _texture_3d_update(RID p_texture, const TypedArray<Image> &p_data);
1897
TypedArray<Image> _texture_3d_get(RID p_texture) const;
1898
TypedArray<Dictionary> _shader_get_shader_parameter_list(RID p_shader) const;
1899
RID _mesh_create_from_surfaces(const TypedArray<Dictionary> &p_surfaces, int p_blend_shape_count);
1900
void _mesh_add_surface(RID p_mesh, const Dictionary &p_surface);
1901
Dictionary _mesh_get_surface(RID p_mesh, int p_idx);
1902
TypedArray<Dictionary> _instance_geometry_get_shader_parameter_list(RID p_instance) const;
1903
TypedArray<Dictionary> _canvas_item_get_instance_shader_parameter_list(RID p_item) const;
1904
TypedArray<Image> _bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size);
1905
void _particles_set_trail_bind_poses(RID p_particles, const TypedArray<Transform3D> &p_bind_poses);
1906
#ifdef TOOLS_ENABLED
1907
SurfaceUpgradeCallback surface_upgrade_callback = nullptr;
1908
bool warn_on_surface_upgrade = true;
1909
#endif
1910
};
1911
1912
// Make variant understand the enums.
1913
VARIANT_ENUM_CAST(RenderingServer::TextureType);
1914
VARIANT_ENUM_CAST(RenderingServer::TextureLayeredType);
1915
VARIANT_ENUM_CAST(RenderingServer::CubeMapLayer);
1916
VARIANT_ENUM_CAST(RenderingServer::PipelineSource);
1917
VARIANT_ENUM_CAST(RenderingServer::ShaderMode);
1918
VARIANT_ENUM_CAST(RenderingServer::ArrayType);
1919
VARIANT_BITFIELD_CAST(RenderingServer::ArrayFormat);
1920
VARIANT_ENUM_CAST(RenderingServer::ArrayCustomFormat);
1921
VARIANT_ENUM_CAST(RenderingServer::PrimitiveType);
1922
VARIANT_ENUM_CAST(RenderingServer::BlendShapeMode);
1923
VARIANT_ENUM_CAST(RenderingServer::MultimeshTransformFormat);
1924
VARIANT_ENUM_CAST(RenderingServer::MultimeshPhysicsInterpolationQuality);
1925
VARIANT_ENUM_CAST(RenderingServer::LightType);
1926
VARIANT_ENUM_CAST(RenderingServer::LightParam);
1927
VARIANT_ENUM_CAST(RenderingServer::LightBakeMode);
1928
VARIANT_ENUM_CAST(RenderingServer::LightOmniShadowMode);
1929
VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowMode);
1930
VARIANT_ENUM_CAST(RenderingServer::LightDirectionalSkyMode);
1931
VARIANT_ENUM_CAST(RenderingServer::LightProjectorFilter);
1932
VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeUpdateMode);
1933
VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeAmbientMode);
1934
VARIANT_ENUM_CAST(RenderingServer::VoxelGIQuality);
1935
VARIANT_ENUM_CAST(RenderingServer::DecalTexture);
1936
VARIANT_ENUM_CAST(RenderingServer::DecalFilter);
1937
VARIANT_ENUM_CAST(RenderingServer::ParticlesMode);
1938
VARIANT_ENUM_CAST(RenderingServer::ParticlesTransformAlign);
1939
VARIANT_ENUM_CAST(RenderingServer::ParticlesDrawOrder);
1940
VARIANT_ENUM_CAST(RenderingServer::ParticlesEmitFlags);
1941
VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionType);
1942
VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionHeightfieldResolution);
1943
VARIANT_ENUM_CAST(RenderingServer::FogVolumeShape);
1944
VARIANT_ENUM_CAST(RenderingServer::ViewportScaling3DMode);
1945
VARIANT_ENUM_CAST(RenderingServer::ViewportUpdateMode);
1946
VARIANT_ENUM_CAST(RenderingServer::ViewportClearMode);
1947
VARIANT_ENUM_CAST(RenderingServer::ViewportEnvironmentMode);
1948
VARIANT_ENUM_CAST(RenderingServer::ViewportMSAA);
1949
VARIANT_ENUM_CAST(RenderingServer::ViewportAnisotropicFiltering);
1950
VARIANT_ENUM_CAST(RenderingServer::ViewportScreenSpaceAA);
1951
VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfo);
1952
VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfoType);
1953
VARIANT_ENUM_CAST(RenderingServer::ViewportDebugDraw);
1954
VARIANT_ENUM_CAST(RenderingServer::ViewportOcclusionCullingBuildQuality);
1955
VARIANT_ENUM_CAST(RenderingServer::ViewportSDFOversize);
1956
VARIANT_ENUM_CAST(RenderingServer::ViewportSDFScale);
1957
VARIANT_ENUM_CAST(RenderingServer::ViewportVRSMode);
1958
VARIANT_ENUM_CAST(RenderingServer::ViewportVRSUpdateMode);
1959
VARIANT_ENUM_CAST(RenderingServer::SkyMode);
1960
VARIANT_ENUM_CAST(RenderingServer::CompositorEffectCallbackType);
1961
VARIANT_ENUM_CAST(RenderingServer::CompositorEffectFlags);
1962
VARIANT_ENUM_CAST(RenderingServer::EnvironmentBG);
1963
VARIANT_ENUM_CAST(RenderingServer::EnvironmentAmbientSource);
1964
VARIANT_ENUM_CAST(RenderingServer::EnvironmentReflectionSource);
1965
VARIANT_ENUM_CAST(RenderingServer::EnvironmentGlowBlendMode);
1966
VARIANT_ENUM_CAST(RenderingServer::EnvironmentFogMode);
1967
VARIANT_ENUM_CAST(RenderingServer::EnvironmentToneMapper);
1968
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSRRoughnessQuality);
1969
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSAOQuality);
1970
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSILQuality);
1971
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToConverge);
1972
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIRayCount);
1973
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToUpdateLight);
1974
VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIYScale);
1975
VARIANT_ENUM_CAST(RenderingServer::SubSurfaceScatteringQuality);
1976
VARIANT_ENUM_CAST(RenderingServer::DOFBlurQuality);
1977
VARIANT_ENUM_CAST(RenderingServer::DOFBokehShape);
1978
VARIANT_ENUM_CAST(RenderingServer::ShadowQuality);
1979
VARIANT_ENUM_CAST(RenderingServer::InstanceType);
1980
VARIANT_ENUM_CAST(RenderingServer::InstanceFlags);
1981
VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);
1982
VARIANT_ENUM_CAST(RenderingServer::VisibilityRangeFadeMode);
1983
VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);
1984
VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);
1985
VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);
1986
VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);
1987
VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);
1988
VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);
1989
VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);
1990
VARIANT_ENUM_CAST(RenderingServer::CanvasOccluderPolygonCullMode);
1991
VARIANT_ENUM_CAST(RenderingServer::GlobalShaderParameterType);
1992
VARIANT_ENUM_CAST(RenderingServer::RenderingInfo);
1993
VARIANT_ENUM_CAST(RenderingServer::CanvasTextureChannel);
1994
VARIANT_ENUM_CAST(RenderingServer::BakeChannels);
1995
1996
#ifndef DISABLE_DEPRECATED
1997
VARIANT_ENUM_CAST(RenderingServer::Features);
1998
#endif
1999
2000
// Alias to make it easier to use.
2001
#define RS RenderingServer
2002
2003