Path: blob/master/servers/rendering/rendering_server.h
11322 views
/**************************************************************************/1/* rendering_server.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#include "core/io/image.h"33#include "core/math/geometry_3d.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"4041// Helper macros for code outside of the rendering server, but that is42// called by the rendering server.43#ifdef DEBUG_ENABLED44#define ERR_NOT_ON_RENDER_THREAD \45RenderingServer *rendering_server = RenderingServer::get_singleton(); \46ERR_FAIL_NULL(rendering_server); \47ERR_FAIL_COND(!rendering_server->is_on_render_thread());48#define ERR_NOT_ON_RENDER_THREAD_V(m_ret) \49RenderingServer *rendering_server = RenderingServer::get_singleton(); \50ERR_FAIL_NULL_V(rendering_server, m_ret); \51ERR_FAIL_COND_V(!rendering_server->is_on_render_thread(), m_ret);52#else53#define ERR_NOT_ON_RENDER_THREAD54#define ERR_NOT_ON_RENDER_THREAD_V(m_ret)55#endif5657class RenderingServer : public Object {58GDCLASS(RenderingServer, Object);5960static RenderingServer *singleton;6162int mm_policy = 0;63bool render_loop_enabled = true;6465Array _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;6667const Vector2 SMALL_VEC2 = Vector2(CMP_EPSILON, CMP_EPSILON);68const Vector3 SMALL_VEC3 = Vector3(CMP_EPSILON, CMP_EPSILON, CMP_EPSILON);6970virtual TypedArray<StringName> _global_shader_parameter_get_list() const;7172protected:73RID _make_test_cube();74void _free_internal_rids();75RID test_texture;76RID white_texture;77RID test_material;7879Error _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);8081static RenderingServer *(*create_func)();82static void _bind_methods();8384#ifndef DISABLE_DEPRECATED85void _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);86void _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);87void _canvas_item_add_rect_bind_compat_84523(RID p_item, const Rect2 &p_rect, const Color &p_color);88void _canvas_item_add_circle_bind_compat_84523(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color);89void _instance_set_interpolated_bind_compat_104269(RID p_instance, bool p_interpolated);90void _instance_reset_physics_interpolation_bind_compat_104269(RID p_instance);9192static void _bind_compatibility_methods();93#endif9495public:96static RenderingServer *get_singleton();97static RenderingServer *create();9899enum {100NO_INDEX_ARRAY = -1,101ARRAY_WEIGHTS_SIZE = 4,102CANVAS_ITEM_Z_MIN = -4096,103CANVAS_ITEM_Z_MAX = 4096,104CANVAS_LAYER_MIN = -2147483648,105CANVAS_LAYER_MAX = 2147483647,106MAX_GLOW_LEVELS = 7,107MAX_CURSORS = 8,108MAX_2D_DIRECTIONAL_LIGHTS = 8,109MAX_MESH_SURFACES = 256110};111112/* TEXTURE API */113114enum TextureType {115TEXTURE_TYPE_2D,116TEXTURE_TYPE_LAYERED,117TEXTURE_TYPE_3D,118};119120enum TextureLayeredType {121TEXTURE_LAYERED_2D_ARRAY,122TEXTURE_LAYERED_CUBEMAP,123TEXTURE_LAYERED_CUBEMAP_ARRAY,124};125126enum CubeMapLayer {127CUBEMAP_LAYER_LEFT,128CUBEMAP_LAYER_RIGHT,129CUBEMAP_LAYER_BOTTOM,130CUBEMAP_LAYER_TOP,131CUBEMAP_LAYER_FRONT,132CUBEMAP_LAYER_BACK133};134135virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;136virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, TextureLayeredType p_layered_type) = 0;137virtual 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 coherent138virtual RID texture_external_create(int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;139virtual RID texture_proxy_create(RID p_base) = 0;140141virtual 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;142143virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;144virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;145virtual void texture_external_update(RID p_texture, int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;146virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;147148// These two APIs can be used together or in combination with the others.149virtual RID texture_2d_placeholder_create() = 0;150virtual RID texture_2d_layered_placeholder_create(TextureLayeredType p_layered_type) = 0;151virtual RID texture_3d_placeholder_create() = 0;152153virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;154virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;155virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;156157virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;158virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;159160virtual void texture_set_path(RID p_texture, const String &p_path) = 0;161virtual String texture_get_path(RID p_texture) const = 0;162163virtual Image::Format texture_get_format(RID p_texture) const = 0;164165typedef void (*TextureDetectCallback)(void *);166167virtual void texture_set_detect_3d_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;168virtual void texture_set_detect_normal_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;169170enum TextureDetectRoughnessChannel {171TEXTURE_DETECT_ROUGHNESS_R,172TEXTURE_DETECT_ROUGHNESS_G,173TEXTURE_DETECT_ROUGHNESS_B,174TEXTURE_DETECT_ROUGHNESS_A,175TEXTURE_DETECT_ROUGHNESS_GRAY,176};177178typedef void (*TextureDetectRoughnessCallback)(void *, const String &, TextureDetectRoughnessChannel);179virtual void texture_set_detect_roughness_callback(RID p_texture, TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;180181struct TextureInfo {182RID texture;183uint32_t width;184uint32_t height;185uint32_t depth;186Image::Format format;187int64_t bytes;188String path;189TextureType type;190};191192virtual void texture_debug_usage(List<TextureInfo> *r_info) = 0;193Array _texture_debug_usage_bind();194195virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;196197virtual RID texture_rd_create(const RID &p_rd_texture, const RenderingServer::TextureLayeredType p_layer_type = RenderingServer::TEXTURE_LAYERED_2D_ARRAY) = 0;198virtual RID texture_get_rd_texture(RID p_texture, bool p_srgb = false) const = 0;199virtual uint64_t texture_get_native_handle(RID p_texture, bool p_srgb = false) const = 0;200201/* PIPELINES API */202203enum PipelineSource {204PIPELINE_SOURCE_CANVAS,205PIPELINE_SOURCE_MESH,206PIPELINE_SOURCE_SURFACE,207PIPELINE_SOURCE_DRAW,208PIPELINE_SOURCE_SPECIALIZATION,209PIPELINE_SOURCE_MAX210};211212/* SHADER API */213214enum ShaderMode {215SHADER_SPATIAL,216SHADER_CANVAS_ITEM,217SHADER_PARTICLES,218SHADER_SKY,219SHADER_FOG,220SHADER_MAX221};222223enum CullMode {224CULL_MODE_DISABLED,225CULL_MODE_FRONT,226CULL_MODE_BACK,227};228229virtual RID shader_create() = 0;230virtual RID shader_create_from_code(const String &p_code, const String &p_path_hint = String()) = 0;231232virtual void shader_set_code(RID p_shader, const String &p_code) = 0;233virtual void shader_set_path_hint(RID p_shader, const String &p_path) = 0;234virtual String shader_get_code(RID p_shader) const = 0;235virtual void get_shader_parameter_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;236virtual Variant shader_get_parameter_default(RID p_shader, const StringName &p_param) const = 0;237238virtual void shader_set_default_texture_parameter(RID p_shader, const StringName &p_name, RID p_texture, int p_index = 0) = 0;239virtual RID shader_get_default_texture_parameter(RID p_shader, const StringName &p_name, int p_index = 0) const = 0;240241struct ShaderNativeSourceCode {242struct Version {243struct Stage {244String name;245String code;246};247Vector<Stage> stages;248};249Vector<Version> versions;250};251252virtual ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;253254/* COMMON MATERIAL API */255256enum {257MATERIAL_RENDER_PRIORITY_MIN = -128,258MATERIAL_RENDER_PRIORITY_MAX = 127,259};260261virtual RID material_create() = 0;262virtual RID material_create_from_shader(RID p_next_pass, int p_render_priority, RID p_shader) = 0;263264virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;265266virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;267virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;268269virtual void material_set_render_priority(RID p_material, int priority) = 0;270271virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;272273/* MESH API */274275enum ArrayType {276ARRAY_VERTEX = 0, // RG32F (2D), RGB32F, RGBA16 (compressed)277ARRAY_NORMAL = 1, // RG16278ARRAY_TANGENT = 2, // BA16 (with normal) or A16 (with vertex, when compressed)279ARRAY_COLOR = 3, // RGBA8280ARRAY_TEX_UV = 4, // RG32F or RG16281ARRAY_TEX_UV2 = 5, // RG32F or RG16282ARRAY_CUSTOM0 = 6, // Depends on ArrayCustomFormat.283ARRAY_CUSTOM1 = 7,284ARRAY_CUSTOM2 = 8,285ARRAY_CUSTOM3 = 9,286ARRAY_BONES = 10, // RGBA16UI (x2 if 8 weights)287ARRAY_WEIGHTS = 11, // RGBA16UNORM (x2 if 8 weights)288ARRAY_INDEX = 12, // 16 or 32 bits depending on length > 0xFFFF.289ARRAY_MAX = 13290};291292enum {293ARRAY_CUSTOM_COUNT = ARRAY_BONES - ARRAY_CUSTOM0294};295296enum ArrayCustomFormat {297ARRAY_CUSTOM_RGBA8_UNORM,298ARRAY_CUSTOM_RGBA8_SNORM,299ARRAY_CUSTOM_RG_HALF,300ARRAY_CUSTOM_RGBA_HALF,301ARRAY_CUSTOM_R_FLOAT,302ARRAY_CUSTOM_RG_FLOAT,303ARRAY_CUSTOM_RGB_FLOAT,304ARRAY_CUSTOM_RGBA_FLOAT,305ARRAY_CUSTOM_MAX306};307308enum ArrayFormat : uint64_t {309/* ARRAY FORMAT FLAGS */310ARRAY_FORMAT_VERTEX = 1 << ARRAY_VERTEX,311ARRAY_FORMAT_NORMAL = 1 << ARRAY_NORMAL,312ARRAY_FORMAT_TANGENT = 1 << ARRAY_TANGENT,313ARRAY_FORMAT_COLOR = 1 << ARRAY_COLOR,314ARRAY_FORMAT_TEX_UV = 1 << ARRAY_TEX_UV,315ARRAY_FORMAT_TEX_UV2 = 1 << ARRAY_TEX_UV2,316ARRAY_FORMAT_CUSTOM0 = 1 << ARRAY_CUSTOM0,317ARRAY_FORMAT_CUSTOM1 = 1 << ARRAY_CUSTOM1,318ARRAY_FORMAT_CUSTOM2 = 1 << ARRAY_CUSTOM2,319ARRAY_FORMAT_CUSTOM3 = 1 << ARRAY_CUSTOM3,320ARRAY_FORMAT_BONES = 1 << ARRAY_BONES,321ARRAY_FORMAT_WEIGHTS = 1 << ARRAY_WEIGHTS,322ARRAY_FORMAT_INDEX = 1 << ARRAY_INDEX,323324ARRAY_FORMAT_BLEND_SHAPE_MASK = ARRAY_FORMAT_VERTEX | ARRAY_FORMAT_NORMAL | ARRAY_FORMAT_TANGENT,325326ARRAY_FORMAT_CUSTOM_BASE = (ARRAY_INDEX + 1),327ARRAY_FORMAT_CUSTOM_BITS = 3,328ARRAY_FORMAT_CUSTOM_MASK = 0x7,329ARRAY_FORMAT_CUSTOM0_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + 0),330ARRAY_FORMAT_CUSTOM1_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS),331ARRAY_FORMAT_CUSTOM2_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 2),332ARRAY_FORMAT_CUSTOM3_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 3),333334ARRAY_COMPRESS_FLAGS_BASE = (ARRAY_INDEX + 1 + 12),335336ARRAY_FLAG_USE_2D_VERTICES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 0),337ARRAY_FLAG_USE_DYNAMIC_UPDATE = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 1),338ARRAY_FLAG_USE_8_BONE_WEIGHTS = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 2),339340ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 3),341342ARRAY_FLAG_COMPRESS_ATTRIBUTES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 4),343// We leave enough room for up to 5 more compression flags.344345ARRAY_FLAG_FORMAT_VERSION_BASE = ARRAY_COMPRESS_FLAGS_BASE + 10,346ARRAY_FLAG_FORMAT_VERSION_SHIFT = ARRAY_FLAG_FORMAT_VERSION_BASE,347// When changes are made to the mesh format, add a new version and use it for the CURRENT_VERSION.348ARRAY_FLAG_FORMAT_VERSION_1 = 0,349ARRAY_FLAG_FORMAT_VERSION_2 = 1ULL << ARRAY_FLAG_FORMAT_VERSION_SHIFT,350ARRAY_FLAG_FORMAT_CURRENT_VERSION = ARRAY_FLAG_FORMAT_VERSION_2,351ARRAY_FLAG_FORMAT_VERSION_MASK = 0xFF, // 8 bits version352};353354static_assert(sizeof(ArrayFormat) == 8, "ArrayFormat should be 64 bits long.");355356enum PrimitiveType {357PRIMITIVE_POINTS,358PRIMITIVE_LINES,359PRIMITIVE_LINE_STRIP,360PRIMITIVE_TRIANGLES,361PRIMITIVE_TRIANGLE_STRIP,362PRIMITIVE_MAX,363};364365struct SurfaceData {366PrimitiveType primitive = PRIMITIVE_MAX;367368uint64_t format = ARRAY_FLAG_FORMAT_CURRENT_VERSION;369Vector<uint8_t> vertex_data; // Vertex, Normal, Tangent (change with skinning, blendshape).370Vector<uint8_t> attribute_data; // Color, UV, UV2, Custom0-3.371Vector<uint8_t> skin_data; // Bone index, Bone weight.372uint32_t vertex_count = 0;373Vector<uint8_t> index_data;374uint32_t index_count = 0;375376AABB aabb;377struct LOD {378float edge_length = 0.0f;379Vector<uint8_t> index_data;380};381Vector<LOD> lods;382Vector<AABB> bone_aabbs;383384// Transforms used in runtime bone AABBs compute.385// Since bone AABBs is saved in Mesh space, but bones is in Skeleton space.386Transform3D mesh_to_skeleton_xform;387388Vector<uint8_t> blend_shape_data;389390Vector4 uv_scale;391392RID material;393};394395virtual RID mesh_create_from_surfaces(const Vector<SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;396virtual RID mesh_create() = 0;397398virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;399400virtual uint32_t mesh_surface_get_format_offset(BitField<ArrayFormat> p_format, int p_vertex_len, int p_array_index) const;401virtual uint32_t mesh_surface_get_format_vertex_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;402virtual uint32_t mesh_surface_get_format_normal_tangent_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;403virtual uint32_t mesh_surface_get_format_attribute_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;404virtual uint32_t mesh_surface_get_format_skin_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;405virtual uint32_t mesh_surface_get_format_index_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;406407/// Returns stride408virtual 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;409virtual 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);410Array mesh_create_arrays_from_surface_data(const SurfaceData &p_data) const;411Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;412TypedArray<Array> mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;413Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;414415virtual 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);416virtual void mesh_add_surface(RID p_mesh, const SurfaceData &p_surface) = 0;417418virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;419420enum BlendShapeMode {421BLEND_SHAPE_MODE_NORMALIZED,422BLEND_SHAPE_MODE_RELATIVE,423};424425virtual void mesh_set_blend_shape_mode(RID p_mesh, BlendShapeMode p_mode) = 0;426virtual BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;427428virtual void mesh_surface_update_vertex_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;429virtual void mesh_surface_update_attribute_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;430virtual void mesh_surface_update_skin_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;431virtual void mesh_surface_update_index_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;432433virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;434virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;435436virtual SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;437438virtual int mesh_get_surface_count(RID p_mesh) const = 0;439440virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;441virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;442443virtual void mesh_set_path(RID p_mesh, const String &p_path) = 0;444virtual String mesh_get_path(RID p_mesh) const = 0;445446virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;447448virtual void mesh_surface_remove(RID p_mesh, int p_surface) = 0;449virtual void mesh_clear(RID p_mesh) = 0;450451struct MeshInfo {452RID mesh;453String path;454uint32_t vertex_buffer_size = 0;455uint32_t attribute_buffer_size = 0;456uint32_t skin_buffer_size = 0;457uint32_t index_buffer_size = 0;458uint32_t blend_shape_buffer_size = 0;459uint32_t lod_index_buffers_size = 0;460uint64_t vertex_count = 0;461};462463virtual void mesh_debug_usage(List<MeshInfo> *r_info) = 0;464465/* MULTIMESH API */466467virtual RID multimesh_create() = 0;468469enum MultimeshTransformFormat {470MULTIMESH_TRANSFORM_2D,471MULTIMESH_TRANSFORM_3D,472};473474enum MultimeshPhysicsInterpolationQuality {475MULTIMESH_INTERP_QUALITY_FAST,476MULTIMESH_INTERP_QUALITY_HIGH,477};478479protected:480#ifndef DISABLE_DEPRECATED481void _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);482#endif483public:484virtual 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;485virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;486487virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;488virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform3D &p_transform) = 0;489virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;490virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;491virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;492493virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;494virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;495496virtual void multimesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;497virtual AABB multimesh_get_custom_aabb(RID p_mesh) const = 0;498499virtual Transform3D multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;500virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;501virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;502virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;503504virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;505virtual RID multimesh_get_command_buffer_rd_rid(RID p_multimesh) const = 0;506virtual RID multimesh_get_buffer_rd_rid(RID p_multimesh) const = 0;507virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;508509// Interpolation.510virtual void multimesh_set_buffer_interpolated(RID p_multimesh, const Vector<float> &p_buffer_curr, const Vector<float> &p_buffer_prev) = 0;511virtual void multimesh_set_physics_interpolated(RID p_multimesh, bool p_interpolated) = 0;512virtual void multimesh_set_physics_interpolation_quality(RID p_multimesh, MultimeshPhysicsInterpolationQuality p_quality) = 0;513virtual void multimesh_instance_reset_physics_interpolation(RID p_multimesh, int p_index) = 0;514515virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;516virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;517518/* SKELETON API */519520virtual RID skeleton_create() = 0;521virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;522virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;523virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform3D &p_transform) = 0;524virtual Transform3D skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;525virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;526virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;527virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;528529/* Light API */530531enum LightType {532LIGHT_DIRECTIONAL,533LIGHT_OMNI,534LIGHT_SPOT535};536537enum LightParam {538LIGHT_PARAM_ENERGY,539LIGHT_PARAM_INDIRECT_ENERGY,540LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY,541LIGHT_PARAM_SPECULAR,542LIGHT_PARAM_RANGE,543LIGHT_PARAM_SIZE,544LIGHT_PARAM_ATTENUATION,545LIGHT_PARAM_SPOT_ANGLE,546LIGHT_PARAM_SPOT_ATTENUATION,547LIGHT_PARAM_SHADOW_MAX_DISTANCE,548LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,549LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,550LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,551LIGHT_PARAM_SHADOW_FADE_START,552LIGHT_PARAM_SHADOW_NORMAL_BIAS,553LIGHT_PARAM_SHADOW_BIAS,554LIGHT_PARAM_SHADOW_PANCAKE_SIZE,555LIGHT_PARAM_SHADOW_OPACITY,556LIGHT_PARAM_SHADOW_BLUR,557LIGHT_PARAM_TRANSMITTANCE_BIAS,558LIGHT_PARAM_INTENSITY,559LIGHT_PARAM_MAX560};561562virtual RID directional_light_create() = 0;563virtual RID omni_light_create() = 0;564virtual RID spot_light_create() = 0;565566virtual void light_set_color(RID p_light, const Color &p_color) = 0;567virtual void light_set_param(RID p_light, LightParam p_param, float p_value) = 0;568virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;569virtual void light_set_projector(RID p_light, RID p_texture) = 0;570virtual void light_set_negative(RID p_light, bool p_enable) = 0;571virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;572virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;573virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;574virtual void light_set_shadow_caster_mask(RID p_light, uint32_t p_caster_mask) = 0;575576enum LightBakeMode {577LIGHT_BAKE_DISABLED,578LIGHT_BAKE_STATIC,579LIGHT_BAKE_DYNAMIC,580};581582virtual void light_set_bake_mode(RID p_light, LightBakeMode p_bake_mode) = 0;583virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;584585// Omni light586enum LightOmniShadowMode {587LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,588LIGHT_OMNI_SHADOW_CUBE,589};590591virtual void light_omni_set_shadow_mode(RID p_light, LightOmniShadowMode p_mode) = 0;592593// Directional light594enum LightDirectionalShadowMode {595LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,596LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,597LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS,598};599600enum LightDirectionalSkyMode {601LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY,602LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY,603LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY,604};605606virtual void light_directional_set_shadow_mode(RID p_light, LightDirectionalShadowMode p_mode) = 0;607virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;608virtual void light_directional_set_sky_mode(RID p_light, LightDirectionalSkyMode p_mode) = 0;609610// Shadow atlas611612virtual RID shadow_atlas_create() = 0;613virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;614virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;615616virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;617618enum ShadowQuality {619SHADOW_QUALITY_HARD,620SHADOW_QUALITY_SOFT_VERY_LOW,621SHADOW_QUALITY_SOFT_LOW,622SHADOW_QUALITY_SOFT_MEDIUM,623SHADOW_QUALITY_SOFT_HIGH,624SHADOW_QUALITY_SOFT_ULTRA,625SHADOW_QUALITY_MAX626};627628virtual void positional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;629virtual void directional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;630631enum LightProjectorFilter {632LIGHT_PROJECTOR_FILTER_NEAREST,633LIGHT_PROJECTOR_FILTER_LINEAR,634LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS,635LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS,636LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,637LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,638};639640virtual void light_projectors_set_filter(LightProjectorFilter p_filter) = 0;641642/* PROBE API */643644virtual RID reflection_probe_create() = 0;645646enum ReflectionProbeUpdateMode {647REFLECTION_PROBE_UPDATE_ONCE,648REFLECTION_PROBE_UPDATE_ALWAYS,649};650651virtual void reflection_probe_set_update_mode(RID p_probe, ReflectionProbeUpdateMode p_mode) = 0;652virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;653virtual void reflection_probe_set_blend_distance(RID p_probe, float p_blend_distance) = 0;654655enum ReflectionProbeAmbientMode {656REFLECTION_PROBE_AMBIENT_DISABLED,657REFLECTION_PROBE_AMBIENT_ENVIRONMENT,658REFLECTION_PROBE_AMBIENT_COLOR,659};660661virtual void reflection_probe_set_ambient_mode(RID p_probe, ReflectionProbeAmbientMode p_mode) = 0;662virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;663virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;664virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;665virtual void reflection_probe_set_size(RID p_probe, const Vector3 &p_size) = 0;666virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;667virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;668virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;669virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;670virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;671virtual void reflection_probe_set_reflection_mask(RID p_probe, uint32_t p_layers) = 0;672virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;673virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_pixels) = 0;674675/* DECAL API */676677enum DecalTexture {678DECAL_TEXTURE_ALBEDO,679DECAL_TEXTURE_NORMAL,680DECAL_TEXTURE_ORM,681DECAL_TEXTURE_EMISSION,682DECAL_TEXTURE_MAX683};684685virtual RID decal_create() = 0;686virtual void decal_set_size(RID p_decal, const Vector3 &p_size) = 0;687virtual void decal_set_texture(RID p_decal, DecalTexture p_type, RID p_texture) = 0;688virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;689virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;690virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;691virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;692virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;693virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;694virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;695696enum DecalFilter {697DECAL_FILTER_NEAREST,698DECAL_FILTER_LINEAR,699DECAL_FILTER_NEAREST_MIPMAPS,700DECAL_FILTER_LINEAR_MIPMAPS,701DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,702DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,703};704705virtual void decals_set_filter(DecalFilter p_quality) = 0;706707/* VOXEL GI API */708709virtual RID voxel_gi_create() = 0;710711virtual 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;712713virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;714virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;715virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;716virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;717virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;718virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;719virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;720721virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;722virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;723virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;724virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;725virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;726virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;727virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;728virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;729730enum VoxelGIQuality {731VOXEL_GI_QUALITY_LOW,732VOXEL_GI_QUALITY_HIGH,733};734735virtual void voxel_gi_set_quality(VoxelGIQuality) = 0;736737virtual void sdfgi_reset() = 0;738739/* LIGHTMAP */740741enum ShadowmaskMode {742SHADOWMASK_MODE_NONE,743SHADOWMASK_MODE_REPLACE,744SHADOWMASK_MODE_OVERLAY,745SHADOWMASK_MODE_ONLY,746};747748virtual RID lightmap_create() = 0;749750virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;751virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;752virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;753virtual 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;754virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;755virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;756virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;757virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;758virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;759760virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;761virtual void lightmaps_set_bicubic_filter(bool p_enable) = 0;762763virtual void lightmap_set_shadowmask_textures(RID p_lightmap, RID p_shadow) = 0;764virtual ShadowmaskMode lightmap_get_shadowmask_mode(RID p_lightmap) = 0;765virtual void lightmap_set_shadowmask_mode(RID p_lightmap, ShadowmaskMode p_mode) = 0;766767/* PARTICLES API */768769virtual RID particles_create() = 0;770771enum ParticlesMode {772PARTICLES_MODE_2D,773PARTICLES_MODE_3D774};775virtual void particles_set_mode(RID p_particles, ParticlesMode p_mode) = 0;776777virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;778virtual bool particles_get_emitting(RID p_particles) = 0;779virtual void particles_set_amount(RID p_particles, int p_amount) = 0;780virtual void particles_set_amount_ratio(RID p_particles, float p_amount_ratio) = 0;781virtual void particles_set_lifetime(RID p_particles, double p_lifetime) = 0;782virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;783virtual void particles_set_pre_process_time(RID p_particles, double p_time) = 0;784virtual void particles_request_process_time(RID p_particles, real_t p_request_process_time) = 0;785virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;786virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;787virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;788virtual void particles_set_speed_scale(RID p_particles, double p_scale) = 0;789virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;790virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;791virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;792virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;793virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;794virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;795virtual void particles_set_seed(RID p_particles, uint32_t p_seed) = 0;796797enum ParticlesTransformAlign {798PARTICLES_TRANSFORM_ALIGN_DISABLED,799PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD,800PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY,801PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY,802};803804virtual void particles_set_transform_align(RID p_particles, ParticlesTransformAlign p_transform_align) = 0;805806virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;807virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) = 0;808809virtual bool particles_is_inactive(RID p_particles) = 0;810virtual void particles_request_process(RID p_particles) = 0;811virtual void particles_restart(RID p_particles) = 0;812813virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;814815enum ParticlesEmitFlags {816PARTICLES_EMIT_FLAG_POSITION = 1,817PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2,818PARTICLES_EMIT_FLAG_VELOCITY = 4,819PARTICLES_EMIT_FLAG_COLOR = 8,820PARTICLES_EMIT_FLAG_CUSTOM = 16821};822823virtual 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;824825enum ParticlesDrawOrder {826PARTICLES_DRAW_ORDER_INDEX,827PARTICLES_DRAW_ORDER_LIFETIME,828PARTICLES_DRAW_ORDER_REVERSE_LIFETIME,829PARTICLES_DRAW_ORDER_VIEW_DEPTH,830};831832virtual void particles_set_draw_order(RID p_particles, ParticlesDrawOrder p_order) = 0;833834virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;835virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;836837virtual AABB particles_get_current_aabb(RID p_particles) = 0;838839virtual void particles_set_emission_transform(RID p_particles, const Transform3D &p_transform) = 0; // This is only used for 2D, in 3D it's automatic.840virtual void particles_set_emitter_velocity(RID p_particles, const Vector3 &p_velocity) = 0;841virtual void particles_set_interp_to_end(RID p_particles, float p_interp) = 0;842843/* PARTICLES COLLISION API */844845virtual RID particles_collision_create() = 0;846847enum ParticlesCollisionType {848PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT,849PARTICLES_COLLISION_TYPE_BOX_ATTRACT,850PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT,851PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE,852PARTICLES_COLLISION_TYPE_BOX_COLLIDE,853PARTICLES_COLLISION_TYPE_SDF_COLLIDE,854PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE,855};856857virtual void particles_collision_set_collision_type(RID p_particles_collision, ParticlesCollisionType p_type) = 0;858virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;859virtual void particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) = 0; // For spheres.860virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; // For non-spheres.861virtual void particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) = 0;862virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) = 0;863virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) = 0;864virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; // For SDF and vector field, heightfield is dynamic.865866virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; // For SDF and vector field.867868enum ParticlesCollisionHeightfieldResolution { // Longest axis resolution.869PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256,870PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512,871PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024,872PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048,873PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096,874PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192,875PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX,876};877878virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, ParticlesCollisionHeightfieldResolution p_resolution) = 0; // For SDF and vector field.879virtual void particles_collision_set_height_field_mask(RID p_particles_collision, uint32_t p_heightfield_mask) = 0;880881/* FOG VOLUME API */882883virtual RID fog_volume_create() = 0;884885enum FogVolumeShape {886FOG_VOLUME_SHAPE_ELLIPSOID,887FOG_VOLUME_SHAPE_CONE,888FOG_VOLUME_SHAPE_CYLINDER,889FOG_VOLUME_SHAPE_BOX,890FOG_VOLUME_SHAPE_WORLD,891FOG_VOLUME_SHAPE_MAX,892};893894virtual void fog_volume_set_shape(RID p_fog_volume, FogVolumeShape p_shape) = 0;895virtual void fog_volume_set_size(RID p_fog_volume, const Vector3 &p_size) = 0;896virtual void fog_volume_set_material(RID p_fog_volume, RID p_material) = 0;897898/* VISIBILITY NOTIFIER API */899900virtual RID visibility_notifier_create() = 0;901virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) = 0;902virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;903904/* OCCLUDER API */905906virtual RID occluder_create() = 0;907virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;908909/* CAMERA API */910911virtual RID camera_create() = 0;912virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;913virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;914virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;915virtual void camera_set_transform(RID p_camera, const Transform3D &p_transform) = 0;916virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;917virtual void camera_set_environment(RID p_camera, RID p_env) = 0;918virtual void camera_set_camera_attributes(RID p_camera, RID p_camera_attributes) = 0;919virtual void camera_set_compositor(RID p_camera, RID p_compositor) = 0;920virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;921922/* VIEWPORT API */923924enum CanvasItemTextureFilter {925CANVAS_ITEM_TEXTURE_FILTER_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.926CANVAS_ITEM_TEXTURE_FILTER_NEAREST,927CANVAS_ITEM_TEXTURE_FILTER_LINEAR,928CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS,929CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS,930CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC,931CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC,932CANVAS_ITEM_TEXTURE_FILTER_MAX933};934935enum CanvasItemTextureRepeat {936CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.937CANVAS_ITEM_TEXTURE_REPEAT_DISABLED,938CANVAS_ITEM_TEXTURE_REPEAT_ENABLED,939CANVAS_ITEM_TEXTURE_REPEAT_MIRROR,940CANVAS_ITEM_TEXTURE_REPEAT_MAX,941};942943virtual RID viewport_create() = 0;944945enum ViewportScaling3DMode {946VIEWPORT_SCALING_3D_MODE_BILINEAR,947VIEWPORT_SCALING_3D_MODE_FSR,948VIEWPORT_SCALING_3D_MODE_FSR2,949VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL,950VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL,951VIEWPORT_SCALING_3D_MODE_MAX,952VIEWPORT_SCALING_3D_MODE_OFF = 255, // for internal use only953};954955enum ViewportAnisotropicFiltering {956VIEWPORT_ANISOTROPY_DISABLED,957VIEWPORT_ANISOTROPY_2X,958VIEWPORT_ANISOTROPY_4X,959VIEWPORT_ANISOTROPY_8X,960VIEWPORT_ANISOTROPY_16X,961VIEWPORT_ANISOTROPY_MAX962};963964enum ViewportScaling3DType {965VIEWPORT_SCALING_3D_TYPE_NONE,966VIEWPORT_SCALING_3D_TYPE_TEMPORAL,967VIEWPORT_SCALING_3D_TYPE_SPATIAL,968VIEWPORT_SCALING_3D_TYPE_MAX,969};970971_ALWAYS_INLINE_ static ViewportScaling3DType scaling_3d_mode_type(ViewportScaling3DMode p_mode) {972if (p_mode == VIEWPORT_SCALING_3D_MODE_BILINEAR || p_mode == VIEWPORT_SCALING_3D_MODE_FSR || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL) {973return VIEWPORT_SCALING_3D_TYPE_SPATIAL;974} else if (p_mode == VIEWPORT_SCALING_3D_MODE_FSR2 || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL) {975return VIEWPORT_SCALING_3D_TYPE_TEMPORAL;976}977return VIEWPORT_SCALING_3D_TYPE_NONE;978}979980virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;981virtual void viewport_set_size(RID p_viewport, int p_width, int p_height) = 0;982virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;983virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;984virtual void viewport_set_canvas_cull_mask(RID p_viewport, uint32_t p_canvas_cull_mask) = 0;985986virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID) = 0;987virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;988989virtual void viewport_set_scaling_3d_mode(RID p_viewport, ViewportScaling3DMode p_scaling_3d_mode) = 0;990virtual void viewport_set_scaling_3d_scale(RID p_viewport, float p_scaling_3d_scale) = 0;991virtual void viewport_set_fsr_sharpness(RID p_viewport, float p_fsr_sharpness) = 0;992virtual void viewport_set_texture_mipmap_bias(RID p_viewport, float p_texture_mipmap_bias) = 0;993virtual void viewport_set_anisotropic_filtering_level(RID p_viewport, ViewportAnisotropicFiltering p_anisotropic_filtering_level) = 0;994995enum ViewportUpdateMode {996VIEWPORT_UPDATE_DISABLED,997VIEWPORT_UPDATE_ONCE, // Then goes to disabled, must be manually updated.998VIEWPORT_UPDATE_WHEN_VISIBLE, // Default999VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE,1000VIEWPORT_UPDATE_ALWAYS1001};10021003virtual void viewport_set_update_mode(RID p_viewport, ViewportUpdateMode p_mode) = 0;1004virtual ViewportUpdateMode viewport_get_update_mode(RID p_viewport) const = 0;10051006enum ViewportClearMode {1007VIEWPORT_CLEAR_ALWAYS,1008VIEWPORT_CLEAR_NEVER,1009VIEWPORT_CLEAR_ONLY_NEXT_FRAME1010};10111012virtual void viewport_set_clear_mode(RID p_viewport, ViewportClearMode p_clear_mode) = 0;10131014virtual RID viewport_get_render_target(RID p_viewport) const = 0;1015virtual RID viewport_get_texture(RID p_viewport) const = 0;10161017enum ViewportEnvironmentMode {1018VIEWPORT_ENVIRONMENT_DISABLED,1019VIEWPORT_ENVIRONMENT_ENABLED,1020VIEWPORT_ENVIRONMENT_INHERIT,1021VIEWPORT_ENVIRONMENT_MAX,1022};10231024virtual void viewport_set_environment_mode(RID p_viewport, ViewportEnvironmentMode p_mode) = 0;1025virtual void viewport_set_disable_3d(RID p_viewport, bool p_disable) = 0;1026virtual void viewport_set_disable_2d(RID p_viewport, bool p_disable) = 0;10271028virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;1029virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;1030virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;1031virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;1032virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;1033virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;1034virtual void viewport_set_use_hdr_2d(RID p_viewport, bool p_use_hdr) = 0;1035virtual bool viewport_is_using_hdr_2d(RID p_viewport) const = 0;1036virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;1037virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;10381039virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, CanvasItemTextureFilter p_filter) = 0;1040virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, CanvasItemTextureRepeat p_repeat) = 0;10411042virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;1043virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;10441045enum ViewportSDFOversize {1046VIEWPORT_SDF_OVERSIZE_100_PERCENT,1047VIEWPORT_SDF_OVERSIZE_120_PERCENT,1048VIEWPORT_SDF_OVERSIZE_150_PERCENT,1049VIEWPORT_SDF_OVERSIZE_200_PERCENT,1050VIEWPORT_SDF_OVERSIZE_MAX1051};10521053enum ViewportSDFScale {1054VIEWPORT_SDF_SCALE_100_PERCENT,1055VIEWPORT_SDF_SCALE_50_PERCENT,1056VIEWPORT_SDF_SCALE_25_PERCENT,1057VIEWPORT_SDF_SCALE_MAX1058};10591060virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, ViewportSDFOversize p_oversize, ViewportSDFScale p_scale) = 0;10611062virtual void viewport_set_positional_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = true) = 0;1063virtual void viewport_set_positional_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;10641065enum ViewportMSAA {1066VIEWPORT_MSAA_DISABLED,1067VIEWPORT_MSAA_2X,1068VIEWPORT_MSAA_4X,1069VIEWPORT_MSAA_8X,1070VIEWPORT_MSAA_MAX,1071};10721073virtual void viewport_set_msaa_3d(RID p_viewport, ViewportMSAA p_msaa) = 0;1074virtual void viewport_set_msaa_2d(RID p_viewport, ViewportMSAA p_msaa) = 0;10751076enum ViewportScreenSpaceAA {1077VIEWPORT_SCREEN_SPACE_AA_DISABLED,1078VIEWPORT_SCREEN_SPACE_AA_FXAA,1079VIEWPORT_SCREEN_SPACE_AA_SMAA,1080VIEWPORT_SCREEN_SPACE_AA_MAX,1081};10821083virtual void viewport_set_screen_space_aa(RID p_viewport, ViewportScreenSpaceAA p_mode) = 0;10841085virtual void viewport_set_use_taa(RID p_viewport, bool p_use_taa) = 0;10861087virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;10881089virtual void viewport_set_force_motion_vectors(RID p_viewport, bool p_force_motion_vectors) = 0;10901091virtual void viewport_set_mesh_lod_threshold(RID p_viewport, float p_pixels) = 0;10921093virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling) = 0;1094virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;10951096enum ViewportOcclusionCullingBuildQuality {1097VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0,1098VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1,1099VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2,1100};11011102virtual void viewport_set_occlusion_culling_build_quality(ViewportOcclusionCullingBuildQuality p_quality) = 0;11031104enum ViewportRenderInfo {1105VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME,1106VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME,1107VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME,1108VIEWPORT_RENDER_INFO_MAX,1109};11101111enum ViewportRenderInfoType {1112VIEWPORT_RENDER_INFO_TYPE_VISIBLE,1113VIEWPORT_RENDER_INFO_TYPE_SHADOW,1114VIEWPORT_RENDER_INFO_TYPE_CANVAS,1115VIEWPORT_RENDER_INFO_TYPE_MAX1116};11171118virtual int viewport_get_render_info(RID p_viewport, ViewportRenderInfoType p_type, ViewportRenderInfo p_info) = 0;11191120enum ViewportDebugDraw {1121VIEWPORT_DEBUG_DRAW_DISABLED,1122VIEWPORT_DEBUG_DRAW_UNSHADED,1123VIEWPORT_DEBUG_DRAW_LIGHTING,1124VIEWPORT_DEBUG_DRAW_OVERDRAW,1125VIEWPORT_DEBUG_DRAW_WIREFRAME,1126VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER,1127VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO,1128VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING,1129VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION,1130VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS,1131VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS,1132VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE,1133VIEWPORT_DEBUG_DRAW_SSAO,1134VIEWPORT_DEBUG_DRAW_SSIL,1135VIEWPORT_DEBUG_DRAW_PSSM_SPLITS,1136VIEWPORT_DEBUG_DRAW_DECAL_ATLAS,1137VIEWPORT_DEBUG_DRAW_SDFGI,1138VIEWPORT_DEBUG_DRAW_SDFGI_PROBES,1139VIEWPORT_DEBUG_DRAW_GI_BUFFER,1140VIEWPORT_DEBUG_DRAW_DISABLE_LOD,1141VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS,1142VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS,1143VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS,1144VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES,1145VIEWPORT_DEBUG_DRAW_OCCLUDERS,1146VIEWPORT_DEBUG_DRAW_MOTION_VECTORS,1147VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER,1148};11491150virtual void viewport_set_debug_draw(RID p_viewport, ViewportDebugDraw p_draw) = 0;11511152virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;1153virtual double viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;1154virtual double viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;11551156virtual RID viewport_find_from_screen_attachment(DisplayServer::WindowID p_id = DisplayServer::MAIN_WINDOW_ID) const = 0;11571158enum ViewportVRSMode {1159VIEWPORT_VRS_DISABLED,1160VIEWPORT_VRS_TEXTURE,1161VIEWPORT_VRS_XR,1162VIEWPORT_VRS_MAX,1163};11641165enum ViewportVRSUpdateMode {1166VIEWPORT_VRS_UPDATE_DISABLED,1167VIEWPORT_VRS_UPDATE_ONCE,1168VIEWPORT_VRS_UPDATE_ALWAYS,1169VIEWPORT_VRS_UPDATE_MAX,1170};11711172virtual void viewport_set_vrs_mode(RID p_viewport, ViewportVRSMode p_mode) = 0;1173virtual void viewport_set_vrs_update_mode(RID p_viewport, ViewportVRSUpdateMode p_mode) = 0;1174virtual void viewport_set_vrs_texture(RID p_viewport, RID p_texture) = 0;11751176/* SKY API */11771178enum SkyMode {1179SKY_MODE_AUTOMATIC,1180SKY_MODE_QUALITY,1181SKY_MODE_INCREMENTAL,1182SKY_MODE_REALTIME1183};11841185virtual RID sky_create() = 0;1186virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;1187virtual void sky_set_mode(RID p_sky, SkyMode p_mode) = 0;1188virtual void sky_set_material(RID p_sky, RID p_material) = 0;1189virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;11901191/* COMPOSITOR EFFECTS API */11921193enum CompositorEffectFlags {1194COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR = 1,1195COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH = 2,1196COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS = 4,1197COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS = 8,1198COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR = 16,1199};12001201enum CompositorEffectCallbackType {1202COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE,1203COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE,1204COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY,1205COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT,1206COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT,1207COMPOSITOR_EFFECT_CALLBACK_TYPE_MAX,1208COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY = -1,1209};12101211virtual RID compositor_effect_create() = 0;1212virtual void compositor_effect_set_enabled(RID p_effect, bool p_enabled) = 0;1213virtual void compositor_effect_set_callback(RID p_effect, CompositorEffectCallbackType p_callback_type, const Callable &p_callback) = 0;1214virtual void compositor_effect_set_flag(RID p_effect, CompositorEffectFlags p_flag, bool p_set) = 0;12151216/* COMPOSITOR API */12171218virtual RID compositor_create() = 0;12191220virtual void compositor_set_compositor_effects(RID p_compositor, const TypedArray<RID> &p_effects) = 0;12211222/* ENVIRONMENT API */12231224virtual RID environment_create() = 0;12251226enum EnvironmentBG {1227ENV_BG_CLEAR_COLOR,1228ENV_BG_COLOR,1229ENV_BG_SKY,1230ENV_BG_CANVAS,1231ENV_BG_KEEP,1232ENV_BG_CAMERA_FEED,1233ENV_BG_MAX1234};12351236enum EnvironmentAmbientSource {1237ENV_AMBIENT_SOURCE_BG,1238ENV_AMBIENT_SOURCE_DISABLED,1239ENV_AMBIENT_SOURCE_COLOR,1240ENV_AMBIENT_SOURCE_SKY,1241};12421243enum EnvironmentReflectionSource {1244ENV_REFLECTION_SOURCE_BG,1245ENV_REFLECTION_SOURCE_DISABLED,1246ENV_REFLECTION_SOURCE_SKY,1247};12481249virtual void environment_set_background(RID p_env, EnvironmentBG p_bg) = 0;1250virtual void environment_set_sky(RID p_env, RID p_sky) = 0;1251virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;1252virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;1253virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;1254virtual void environment_set_bg_energy(RID p_env, float p_multiplier, float p_exposure_value) = 0;1255virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;1256virtual 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;1257virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;12581259enum EnvironmentGlowBlendMode {1260ENV_GLOW_BLEND_MODE_ADDITIVE,1261ENV_GLOW_BLEND_MODE_SCREEN,1262ENV_GLOW_BLEND_MODE_SOFTLIGHT,1263ENV_GLOW_BLEND_MODE_REPLACE,1264ENV_GLOW_BLEND_MODE_MIX,1265};12661267virtual 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;12681269virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;12701271enum EnvironmentToneMapper {1272ENV_TONE_MAPPER_LINEAR,1273ENV_TONE_MAPPER_REINHARD,1274ENV_TONE_MAPPER_FILMIC,1275ENV_TONE_MAPPER_ACES,1276ENV_TONE_MAPPER_AGX,1277};12781279virtual void environment_set_tonemap(RID p_env, EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white) = 0;1280virtual 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;12811282virtual 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;12831284enum EnvironmentSSRRoughnessQuality {1285ENV_SSR_ROUGHNESS_QUALITY_DISABLED,1286ENV_SSR_ROUGHNESS_QUALITY_LOW,1287ENV_SSR_ROUGHNESS_QUALITY_MEDIUM,1288ENV_SSR_ROUGHNESS_QUALITY_HIGH,1289};12901291virtual void environment_set_ssr_roughness_quality(EnvironmentSSRRoughnessQuality p_quality) = 0;12921293virtual 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;12941295enum EnvironmentSSAOQuality {1296ENV_SSAO_QUALITY_VERY_LOW,1297ENV_SSAO_QUALITY_LOW,1298ENV_SSAO_QUALITY_MEDIUM,1299ENV_SSAO_QUALITY_HIGH,1300ENV_SSAO_QUALITY_ULTRA,1301};13021303virtual 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;13041305virtual void environment_set_ssil(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_sharpness, float p_normal_rejection) = 0;13061307enum EnvironmentSSILQuality {1308ENV_SSIL_QUALITY_VERY_LOW,1309ENV_SSIL_QUALITY_LOW,1310ENV_SSIL_QUALITY_MEDIUM,1311ENV_SSIL_QUALITY_HIGH,1312ENV_SSIL_QUALITY_ULTRA,1313};13141315virtual 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;13161317enum EnvironmentSDFGIYScale {1318ENV_SDFGI_Y_SCALE_50_PERCENT,1319ENV_SDFGI_Y_SCALE_75_PERCENT,1320ENV_SDFGI_Y_SCALE_100_PERCENT,1321};13221323virtual 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;13241325enum EnvironmentSDFGIRayCount {1326ENV_SDFGI_RAY_COUNT_4,1327ENV_SDFGI_RAY_COUNT_8,1328ENV_SDFGI_RAY_COUNT_16,1329ENV_SDFGI_RAY_COUNT_32,1330ENV_SDFGI_RAY_COUNT_64,1331ENV_SDFGI_RAY_COUNT_96,1332ENV_SDFGI_RAY_COUNT_128,1333ENV_SDFGI_RAY_COUNT_MAX,1334};13351336virtual void environment_set_sdfgi_ray_count(EnvironmentSDFGIRayCount p_ray_count) = 0;13371338enum EnvironmentSDFGIFramesToConverge {1339ENV_SDFGI_CONVERGE_IN_5_FRAMES,1340ENV_SDFGI_CONVERGE_IN_10_FRAMES,1341ENV_SDFGI_CONVERGE_IN_15_FRAMES,1342ENV_SDFGI_CONVERGE_IN_20_FRAMES,1343ENV_SDFGI_CONVERGE_IN_25_FRAMES,1344ENV_SDFGI_CONVERGE_IN_30_FRAMES,1345ENV_SDFGI_CONVERGE_MAX1346};13471348virtual void environment_set_sdfgi_frames_to_converge(EnvironmentSDFGIFramesToConverge p_frames) = 0;13491350enum EnvironmentSDFGIFramesToUpdateLight {1351ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME,1352ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES,1353ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES,1354ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES,1355ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES,1356ENV_SDFGI_UPDATE_LIGHT_MAX,1357};13581359virtual void environment_set_sdfgi_frames_to_update_light(EnvironmentSDFGIFramesToUpdateLight p_update) = 0;13601361enum EnvironmentFogMode {1362ENV_FOG_MODE_EXPONENTIAL,1363ENV_FOG_MODE_DEPTH,1364};13651366virtual 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;1367virtual void environment_set_fog_depth(RID p_env, float p_curve, float p_begin, float p_end) = 0;13681369virtual 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;1370virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;1371virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;13721373virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;13741375virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;13761377enum SubSurfaceScatteringQuality {1378SUB_SURFACE_SCATTERING_QUALITY_DISABLED,1379SUB_SURFACE_SCATTERING_QUALITY_LOW,1380SUB_SURFACE_SCATTERING_QUALITY_MEDIUM,1381SUB_SURFACE_SCATTERING_QUALITY_HIGH,1382};13831384virtual void sub_surface_scattering_set_quality(SubSurfaceScatteringQuality p_quality) = 0;1385virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;13861387/* CAMERA EFFECTS */13881389virtual RID camera_attributes_create() = 0;13901391enum DOFBlurQuality {1392DOF_BLUR_QUALITY_VERY_LOW,1393DOF_BLUR_QUALITY_LOW,1394DOF_BLUR_QUALITY_MEDIUM,1395DOF_BLUR_QUALITY_HIGH,1396};13971398virtual void camera_attributes_set_dof_blur_quality(DOFBlurQuality p_quality, bool p_use_jitter) = 0;13991400enum DOFBokehShape {1401DOF_BOKEH_BOX,1402DOF_BOKEH_HEXAGON,1403DOF_BOKEH_CIRCLE1404};14051406virtual void camera_attributes_set_dof_blur_bokeh_shape(DOFBokehShape p_shape) = 0;14071408virtual 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;1409virtual void camera_attributes_set_exposure(RID p_camera_attributes, float p_multiplier, float p_exposure_normalization) = 0;1410virtual 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;14111412/* SCENARIO API */14131414virtual RID scenario_create() = 0;14151416virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;1417virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;1418virtual void scenario_set_camera_attributes(RID p_scenario, RID p_camera_attributes) = 0;1419virtual void scenario_set_compositor(RID p_scenario, RID p_compositor) = 0;14201421/* INSTANCING API */14221423enum InstanceType {1424INSTANCE_NONE,1425INSTANCE_MESH,1426INSTANCE_MULTIMESH,1427INSTANCE_PARTICLES,1428INSTANCE_PARTICLES_COLLISION,1429INSTANCE_LIGHT,1430INSTANCE_REFLECTION_PROBE,1431INSTANCE_DECAL,1432INSTANCE_VOXEL_GI,1433INSTANCE_LIGHTMAP,1434INSTANCE_OCCLUDER,1435INSTANCE_VISIBLITY_NOTIFIER, // TODO: Fix typo in "VISIBILITY" (in 5.0).1436INSTANCE_FOG_VOLUME,1437INSTANCE_MAX,14381439INSTANCE_GEOMETRY_MASK = (1 << INSTANCE_MESH) | (1 << INSTANCE_MULTIMESH) | (1 << INSTANCE_PARTICLES)1440};14411442virtual RID instance_create2(RID p_base, RID p_scenario);14431444virtual RID instance_create() = 0;14451446virtual void instance_set_base(RID p_instance, RID p_base) = 0;1447virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;1448virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;1449virtual void instance_set_pivot_data(RID p_instance, float p_sorting_offset, bool p_use_aabb_center) = 0;1450virtual void instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;1451virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;1452virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;1453virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;1454virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;14551456virtual void instance_teleport(RID p_instance) = 0;14571458virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;14591460virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;14611462virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;1463virtual void instance_set_visibility_parent(RID p_instance, RID p_parent_instance) = 0;14641465virtual void instance_set_ignore_culling(RID p_instance, bool p_enabled) = 0;14661467// Don't use these in a game!1468virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;1469virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;1470virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;14711472PackedInt64Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;1473PackedInt64Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;1474PackedInt64Array _instances_cull_convex_bind(const TypedArray<Plane> &p_convex, RID p_scenario = RID()) const;14751476enum InstanceFlags {1477INSTANCE_FLAG_USE_BAKED_LIGHT,1478INSTANCE_FLAG_USE_DYNAMIC_GI,1479INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE,1480INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING,1481INSTANCE_FLAG_MAX1482};14831484enum ShadowCastingSetting {1485SHADOW_CASTING_SETTING_OFF,1486SHADOW_CASTING_SETTING_ON,1487SHADOW_CASTING_SETTING_DOUBLE_SIDED,1488SHADOW_CASTING_SETTING_SHADOWS_ONLY,1489};14901491enum VisibilityRangeFadeMode {1492VISIBILITY_RANGE_FADE_DISABLED,1493VISIBILITY_RANGE_FADE_SELF,1494VISIBILITY_RANGE_FADE_DEPENDENCIES,1495};14961497virtual void instance_geometry_set_flag(RID p_instance, InstanceFlags p_flags, bool p_enabled) = 0;1498virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, ShadowCastingSetting p_shadow_casting_setting) = 0;1499virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;1500virtual void instance_geometry_set_material_overlay(RID p_instance, RID p_material) = 0;1501virtual 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;1502virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;1503virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;1504virtual void instance_geometry_set_transparency(RID p_instance, float p_transparency) = 0;15051506virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;1507virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;1508virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;1509virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;15101511/* Bake 3D objects */15121513enum BakeChannels {1514BAKE_CHANNEL_ALBEDO_ALPHA,1515BAKE_CHANNEL_NORMAL,1516BAKE_CHANNEL_ORM,1517BAKE_CHANNEL_EMISSION1518};15191520virtual TypedArray<Image> bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size) = 0;15211522/* CANVAS (2D) */15231524virtual RID canvas_create() = 0;1525virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;1526virtual void canvas_set_item_repeat(RID p_item, const Point2 &p_repeat_size, int p_repeat_times) = 0;1527virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;1528virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;15291530virtual void canvas_set_disable_scale(bool p_disable) = 0;15311532/* CANVAS TEXTURE */1533virtual RID canvas_texture_create() = 0;15341535enum CanvasTextureChannel {1536CANVAS_TEXTURE_CHANNEL_DIFFUSE,1537CANVAS_TEXTURE_CHANNEL_NORMAL,1538CANVAS_TEXTURE_CHANNEL_SPECULAR,1539};1540virtual void canvas_texture_set_channel(RID p_canvas_texture, CanvasTextureChannel p_channel, RID p_texture) = 0;1541virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;15421543// Takes effect only for new draw commands.1544virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, CanvasItemTextureFilter p_filter) = 0;1545virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, CanvasItemTextureRepeat p_repeat) = 0;15461547/* CANVAS ITEM */15481549virtual RID canvas_item_create() = 0;1550virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;15511552virtual void canvas_item_set_default_texture_filter(RID p_item, CanvasItemTextureFilter p_filter) = 0;1553virtual void canvas_item_set_default_texture_repeat(RID p_item, CanvasItemTextureRepeat p_repeat) = 0;15541555virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;1556virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;15571558virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;15591560virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;1561virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;1562virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;1563virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;1564virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;1565virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;1566virtual void canvas_item_set_visibility_layer(RID p_item, uint32_t p_visibility_layer) = 0;15671568virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;1569virtual void canvas_item_set_use_identity_transform(RID p_item, bool p_enabled) = 0;15701571enum NinePatchAxisMode {1572NINE_PATCH_STRETCH,1573NINE_PATCH_TILE,1574NINE_PATCH_TILE_FIT,1575};15761577virtual 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;1578virtual 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;1579virtual 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;1580virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color, bool p_antialiased = false) = 0;1581virtual 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;1582virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color, bool p_antialiased = false) = 0;1583virtual 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;1584virtual 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;1585virtual 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;1586virtual 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;1587virtual 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;1588virtual 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;1589virtual 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;1590virtual 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;1591virtual 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;1592virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;1593virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;1594virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;1595virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;1596virtual 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;15971598virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;1599virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;1600virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;1601virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;16021603virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;16041605virtual void canvas_item_clear(RID p_item) = 0;1606virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;16071608virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;16091610virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;16111612virtual void canvas_item_set_instance_shader_parameter(RID p_item, const StringName &, const Variant &p_value) = 0;1613virtual Variant canvas_item_get_instance_shader_parameter(RID p_item, const StringName &) const = 0;1614virtual Variant canvas_item_get_instance_shader_parameter_default_value(RID p_item, const StringName &) const = 0;1615virtual void canvas_item_get_instance_shader_parameter_list(RID p_item, List<PropertyInfo> *p_parameters) const = 0;16161617virtual 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;16181619enum CanvasGroupMode {1620CANVAS_GROUP_MODE_DISABLED,1621CANVAS_GROUP_MODE_CLIP_ONLY,1622CANVAS_GROUP_MODE_CLIP_AND_DRAW,1623CANVAS_GROUP_MODE_TRANSPARENT,1624};16251626virtual 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;16271628virtual void canvas_item_set_debug_redraw(bool p_enabled) = 0;1629virtual bool canvas_item_get_debug_redraw() const = 0;16301631virtual void canvas_item_set_interpolated(RID p_item, bool p_interpolated) = 0;1632virtual void canvas_item_reset_physics_interpolation(RID p_item) = 0;1633virtual void canvas_item_transform_physics_interpolation(RID p_item, const Transform2D &p_transform) = 0;16341635/* CANVAS LIGHT */1636virtual RID canvas_light_create() = 0;16371638enum CanvasLightMode {1639CANVAS_LIGHT_MODE_POINT,1640CANVAS_LIGHT_MODE_DIRECTIONAL,1641};16421643virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode) = 0;16441645virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;1646virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;1647virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;1648virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;1649virtual void canvas_light_set_height(RID p_light, float p_height) = 0;1650virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;1651virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;1652virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;1653virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;1654virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;16551656virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;16571658virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;1659virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;1660virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;16611662enum CanvasLightBlendMode {1663CANVAS_LIGHT_BLEND_MODE_ADD,1664CANVAS_LIGHT_BLEND_MODE_SUB,1665CANVAS_LIGHT_BLEND_MODE_MIX,1666};16671668virtual void canvas_light_set_blend_mode(RID p_light, CanvasLightBlendMode p_mode) = 0;16691670enum CanvasLightShadowFilter {1671CANVAS_LIGHT_FILTER_NONE,1672CANVAS_LIGHT_FILTER_PCF5,1673CANVAS_LIGHT_FILTER_PCF13,1674CANVAS_LIGHT_FILTER_MAX1675};16761677virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;1678virtual void canvas_light_set_shadow_filter(RID p_light, CanvasLightShadowFilter p_filter) = 0;1679virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;1680virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;16811682virtual void canvas_light_set_interpolated(RID p_light, bool p_interpolated) = 0;1683virtual void canvas_light_reset_physics_interpolation(RID p_light) = 0;1684virtual void canvas_light_transform_physics_interpolation(RID p_light, const Transform2D &p_transform) = 0;16851686/* CANVAS LIGHT OCCLUDER */16871688virtual RID canvas_light_occluder_create() = 0;1689virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;1690virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;1691virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;1692virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;1693virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;1694virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;16951696virtual void canvas_light_occluder_set_interpolated(RID p_occluder, bool p_interpolated) = 0;1697virtual void canvas_light_occluder_reset_physics_interpolation(RID p_occluder) = 0;1698virtual void canvas_light_occluder_transform_physics_interpolation(RID p_occluder, const Transform2D &p_transform) = 0;16991700/* CANVAS LIGHT OCCLUDER POLYGON */17011702virtual RID canvas_occluder_polygon_create() = 0;1703virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;17041705enum CanvasOccluderPolygonCullMode {1706CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,1707CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,1708CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,1709};17101711virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, CanvasOccluderPolygonCullMode p_mode) = 0;17121713virtual void canvas_set_shadow_texture_size(int p_size) = 0;17141715Rect2 debug_canvas_item_get_rect(RID p_item);1716virtual Rect2 _debug_canvas_item_get_rect(RID p_item) = 0;17171718/* GLOBAL SHADER UNIFORMS */17191720enum GlobalShaderParameterType {1721GLOBAL_VAR_TYPE_BOOL,1722GLOBAL_VAR_TYPE_BVEC2,1723GLOBAL_VAR_TYPE_BVEC3,1724GLOBAL_VAR_TYPE_BVEC4,1725GLOBAL_VAR_TYPE_INT,1726GLOBAL_VAR_TYPE_IVEC2,1727GLOBAL_VAR_TYPE_IVEC3,1728GLOBAL_VAR_TYPE_IVEC4,1729GLOBAL_VAR_TYPE_RECT2I,1730GLOBAL_VAR_TYPE_UINT,1731GLOBAL_VAR_TYPE_UVEC2,1732GLOBAL_VAR_TYPE_UVEC3,1733GLOBAL_VAR_TYPE_UVEC4,1734GLOBAL_VAR_TYPE_FLOAT,1735GLOBAL_VAR_TYPE_VEC2,1736GLOBAL_VAR_TYPE_VEC3,1737GLOBAL_VAR_TYPE_VEC4,1738GLOBAL_VAR_TYPE_COLOR,1739GLOBAL_VAR_TYPE_RECT2,1740GLOBAL_VAR_TYPE_MAT2,1741GLOBAL_VAR_TYPE_MAT3,1742GLOBAL_VAR_TYPE_MAT4,1743GLOBAL_VAR_TYPE_TRANSFORM_2D,1744GLOBAL_VAR_TYPE_TRANSFORM,1745GLOBAL_VAR_TYPE_SAMPLER2D,1746GLOBAL_VAR_TYPE_SAMPLER2DARRAY,1747GLOBAL_VAR_TYPE_SAMPLER3D,1748GLOBAL_VAR_TYPE_SAMPLERCUBE,1749GLOBAL_VAR_TYPE_SAMPLEREXT,1750GLOBAL_VAR_TYPE_MAX1751};17521753virtual void global_shader_parameter_add(const StringName &p_name, GlobalShaderParameterType p_type, const Variant &p_value) = 0;1754virtual void global_shader_parameter_remove(const StringName &p_name) = 0;1755virtual Vector<StringName> global_shader_parameter_get_list() const = 0;17561757virtual void global_shader_parameter_set(const StringName &p_name, const Variant &p_value) = 0;1758virtual void global_shader_parameter_set_override(const StringName &p_name, const Variant &p_value) = 0;17591760virtual Variant global_shader_parameter_get(const StringName &p_name) const = 0;1761virtual GlobalShaderParameterType global_shader_parameter_get_type(const StringName &p_name) const = 0;17621763virtual void global_shader_parameters_load_settings(bool p_load_textures) = 0;1764virtual void global_shader_parameters_clear() = 0;17651766static int global_shader_uniform_type_get_shader_datatype(GlobalShaderParameterType p_type);17671768/* FREE */17691770virtual void free_rid(RID p_rid) = 0; // Free RIDs associated with the rendering server.1771#ifndef DISABLE_DEPRECATED1772[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) {1773free_rid(p_rid);1774}1775#endif // DISABLE_DEPRECATED17761777/* INTERPOLATION */17781779virtual void set_physics_interpolation_enabled(bool p_enabled) = 0;17801781/* EVENT QUEUING */17821783virtual void request_frame_drawn_callback(const Callable &p_callable) = 0;17841785virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;1786virtual void sync() = 0;1787virtual bool has_changed() const = 0;1788virtual void init();1789virtual void finish() = 0;1790virtual void tick() = 0;1791virtual void pre_draw(bool p_will_draw) = 0;17921793/* STATUS INFORMATION */17941795enum RenderingInfo {1796RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME,1797RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME,1798RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME,1799RENDERING_INFO_TEXTURE_MEM_USED,1800RENDERING_INFO_BUFFER_MEM_USED,1801RENDERING_INFO_VIDEO_MEM_USED,1802RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS,1803RENDERING_INFO_PIPELINE_COMPILATIONS_MESH,1804RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE,1805RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW,1806RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION,1807RENDERING_INFO_MAX1808};18091810virtual uint64_t get_rendering_info(RenderingInfo p_info) = 0;1811virtual String get_video_adapter_name() const = 0;1812virtual String get_video_adapter_vendor() const = 0;1813virtual RenderingDevice::DeviceType get_video_adapter_type() const = 0;1814virtual String get_video_adapter_api_version() const = 0;18151816struct FrameProfileArea {1817String name;1818double gpu_msec;1819double cpu_msec;1820};18211822virtual void set_frame_profiling_enabled(bool p_enable) = 0;1823virtual Vector<FrameProfileArea> get_frame_profile() = 0;1824virtual uint64_t get_frame_profile_frame() = 0;18251826virtual double get_frame_setup_time_cpu() const = 0;18271828virtual void gi_set_use_half_resolution(bool p_enable) = 0;18291830/* TESTING */18311832virtual RID get_test_cube() = 0;18331834virtual RID get_test_texture();1835virtual RID get_white_texture();18361837virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;18381839virtual RID make_sphere_mesh(int p_lats, int p_lons, real_t p_radius);18401841virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);1842virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);18431844virtual void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true) = 0;1845virtual Color get_default_clear_color() = 0;1846virtual void set_default_clear_color(const Color &p_color) = 0;18471848#ifndef DISABLE_DEPRECATED1849// Never actually used, should be removed when we can break compatibility.1850enum Features {1851FEATURE_SHADERS,1852FEATURE_MULTITHREADED,1853};1854virtual bool has_feature(Features p_feature) const = 0;1855#endif1856virtual bool has_os_feature(const String &p_feature) const = 0;18571858virtual void set_debug_generate_wireframes(bool p_generate) = 0;18591860virtual void call_set_vsync_mode(DisplayServer::VSyncMode p_mode, DisplayServer::WindowID p_window) = 0;18611862virtual bool is_low_end() const = 0;18631864virtual void set_print_gpu_profile(bool p_enable) = 0;18651866virtual Size2i get_maximum_viewport_size() const = 0;18671868RenderingDevice *get_rendering_device() const;1869RenderingDevice *create_local_rendering_device() const;18701871bool is_render_loop_enabled() const;1872void set_render_loop_enabled(bool p_enabled);18731874virtual bool is_on_render_thread() = 0;1875virtual void call_on_render_thread(const Callable &p_callable) = 0;18761877String get_current_rendering_driver_name() const;1878String get_current_rendering_method() const;18791880#ifdef TOOLS_ENABLED1881virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const override;1882#endif18831884RenderingServer();1885virtual ~RenderingServer();18861887#ifdef TOOLS_ENABLED1888typedef void (*SurfaceUpgradeCallback)();1889void set_surface_upgrade_callback(SurfaceUpgradeCallback p_callback);1890void set_warn_on_surface_upgrade(bool p_warn);1891#endif18921893#ifndef DISABLE_DEPRECATED1894void fix_surface_compatibility(SurfaceData &p_surface, const String &p_path = "");1895#endif18961897private:1898// Binder helpers1899RID _texture_2d_layered_create(const TypedArray<Image> &p_layers, TextureLayeredType p_layered_type);1900RID _texture_3d_create(Image::Format p_format, int p_width, int p_height, int p_depth, bool p_mipmaps, const TypedArray<Image> &p_data);1901void _texture_3d_update(RID p_texture, const TypedArray<Image> &p_data);1902TypedArray<Image> _texture_3d_get(RID p_texture) const;1903TypedArray<Dictionary> _shader_get_shader_parameter_list(RID p_shader) const;1904RID _mesh_create_from_surfaces(const TypedArray<Dictionary> &p_surfaces, int p_blend_shape_count);1905void _mesh_add_surface(RID p_mesh, const Dictionary &p_surface);1906Dictionary _mesh_get_surface(RID p_mesh, int p_idx);1907TypedArray<Dictionary> _instance_geometry_get_shader_parameter_list(RID p_instance) const;1908TypedArray<Dictionary> _canvas_item_get_instance_shader_parameter_list(RID p_item) const;1909TypedArray<Image> _bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size);1910void _particles_set_trail_bind_poses(RID p_particles, const TypedArray<Transform3D> &p_bind_poses);1911#ifdef TOOLS_ENABLED1912SurfaceUpgradeCallback surface_upgrade_callback = nullptr;1913bool warn_on_surface_upgrade = true;1914#endif1915};19161917// Make variant understand the enums.1918VARIANT_ENUM_CAST(RenderingServer::TextureType);1919VARIANT_ENUM_CAST(RenderingServer::TextureLayeredType);1920VARIANT_ENUM_CAST(RenderingServer::CubeMapLayer);1921VARIANT_ENUM_CAST(RenderingServer::PipelineSource);1922VARIANT_ENUM_CAST(RenderingServer::ShaderMode);1923VARIANT_ENUM_CAST(RenderingServer::ArrayType);1924VARIANT_BITFIELD_CAST(RenderingServer::ArrayFormat);1925VARIANT_ENUM_CAST(RenderingServer::ArrayCustomFormat);1926VARIANT_ENUM_CAST(RenderingServer::PrimitiveType);1927VARIANT_ENUM_CAST(RenderingServer::BlendShapeMode);1928VARIANT_ENUM_CAST(RenderingServer::MultimeshTransformFormat);1929VARIANT_ENUM_CAST(RenderingServer::MultimeshPhysicsInterpolationQuality);1930VARIANT_ENUM_CAST(RenderingServer::LightType);1931VARIANT_ENUM_CAST(RenderingServer::LightParam);1932VARIANT_ENUM_CAST(RenderingServer::LightBakeMode);1933VARIANT_ENUM_CAST(RenderingServer::LightOmniShadowMode);1934VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowMode);1935VARIANT_ENUM_CAST(RenderingServer::LightDirectionalSkyMode);1936VARIANT_ENUM_CAST(RenderingServer::LightProjectorFilter);1937VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeUpdateMode);1938VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeAmbientMode);1939VARIANT_ENUM_CAST(RenderingServer::VoxelGIQuality);1940VARIANT_ENUM_CAST(RenderingServer::DecalTexture);1941VARIANT_ENUM_CAST(RenderingServer::DecalFilter);1942VARIANT_ENUM_CAST(RenderingServer::ParticlesMode);1943VARIANT_ENUM_CAST(RenderingServer::ParticlesTransformAlign);1944VARIANT_ENUM_CAST(RenderingServer::ParticlesDrawOrder);1945VARIANT_ENUM_CAST(RenderingServer::ParticlesEmitFlags);1946VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionType);1947VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionHeightfieldResolution);1948VARIANT_ENUM_CAST(RenderingServer::FogVolumeShape);1949VARIANT_ENUM_CAST(RenderingServer::ViewportScaling3DMode);1950VARIANT_ENUM_CAST(RenderingServer::ViewportUpdateMode);1951VARIANT_ENUM_CAST(RenderingServer::ViewportClearMode);1952VARIANT_ENUM_CAST(RenderingServer::ViewportEnvironmentMode);1953VARIANT_ENUM_CAST(RenderingServer::ViewportMSAA);1954VARIANT_ENUM_CAST(RenderingServer::ViewportAnisotropicFiltering);1955VARIANT_ENUM_CAST(RenderingServer::ViewportScreenSpaceAA);1956VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfo);1957VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfoType);1958VARIANT_ENUM_CAST(RenderingServer::ViewportDebugDraw);1959VARIANT_ENUM_CAST(RenderingServer::ViewportOcclusionCullingBuildQuality);1960VARIANT_ENUM_CAST(RenderingServer::ViewportSDFOversize);1961VARIANT_ENUM_CAST(RenderingServer::ViewportSDFScale);1962VARIANT_ENUM_CAST(RenderingServer::ViewportVRSMode);1963VARIANT_ENUM_CAST(RenderingServer::ViewportVRSUpdateMode);1964VARIANT_ENUM_CAST(RenderingServer::SkyMode);1965VARIANT_ENUM_CAST(RenderingServer::CompositorEffectCallbackType);1966VARIANT_ENUM_CAST(RenderingServer::CompositorEffectFlags);1967VARIANT_ENUM_CAST(RenderingServer::EnvironmentBG);1968VARIANT_ENUM_CAST(RenderingServer::EnvironmentAmbientSource);1969VARIANT_ENUM_CAST(RenderingServer::EnvironmentReflectionSource);1970VARIANT_ENUM_CAST(RenderingServer::EnvironmentGlowBlendMode);1971VARIANT_ENUM_CAST(RenderingServer::EnvironmentFogMode);1972VARIANT_ENUM_CAST(RenderingServer::EnvironmentToneMapper);1973VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSRRoughnessQuality);1974VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSAOQuality);1975VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSILQuality);1976VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToConverge);1977VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIRayCount);1978VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToUpdateLight);1979VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIYScale);1980VARIANT_ENUM_CAST(RenderingServer::SubSurfaceScatteringQuality);1981VARIANT_ENUM_CAST(RenderingServer::DOFBlurQuality);1982VARIANT_ENUM_CAST(RenderingServer::DOFBokehShape);1983VARIANT_ENUM_CAST(RenderingServer::ShadowQuality);1984VARIANT_ENUM_CAST(RenderingServer::InstanceType);1985VARIANT_ENUM_CAST(RenderingServer::InstanceFlags);1986VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);1987VARIANT_ENUM_CAST(RenderingServer::VisibilityRangeFadeMode);1988VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);1989VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);1990VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);1991VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);1992VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);1993VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);1994VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);1995VARIANT_ENUM_CAST(RenderingServer::CanvasOccluderPolygonCullMode);1996VARIANT_ENUM_CAST(RenderingServer::GlobalShaderParameterType);1997VARIANT_ENUM_CAST(RenderingServer::RenderingInfo);1998VARIANT_ENUM_CAST(RenderingServer::CanvasTextureChannel);1999VARIANT_ENUM_CAST(RenderingServer::BakeChannels);20002001#ifndef DISABLE_DEPRECATED2002VARIANT_ENUM_CAST(RenderingServer::Features);2003#endif20042005// Alias to make it easier to use.2006#define RS RenderingServer200720082009