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