Path: blob/master/servers/rendering/rendering_server.h
20941 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/transform_2d.h"34#include "core/templates/rid.h"35#include "core/variant/typed_array.h"36#include "core/variant/variant.h"37#include "servers/display/display_server.h"38#include "servers/rendering/rendering_device.h"3940namespace Geometry3D {41struct MeshData;42}4344// Helper macros for code outside of the rendering server, but that is45// called by the rendering server.46#ifdef DEBUG_ENABLED47#define ERR_NOT_ON_RENDER_THREAD \48RenderingServer *rendering_server = RenderingServer::get_singleton(); \49ERR_FAIL_NULL(rendering_server); \50ERR_FAIL_COND(!rendering_server->is_on_render_thread());51#define ERR_NOT_ON_RENDER_THREAD_V(m_ret) \52RenderingServer *rendering_server = RenderingServer::get_singleton(); \53ERR_FAIL_NULL_V(rendering_server, m_ret); \54ERR_FAIL_COND_V(!rendering_server->is_on_render_thread(), m_ret);55#else56#define ERR_NOT_ON_RENDER_THREAD57#define ERR_NOT_ON_RENDER_THREAD_V(m_ret)58#endif5960class RenderingServer : public Object {61GDCLASS(RenderingServer, Object);6263static RenderingServer *singleton;6465int mm_policy = 0;66bool render_loop_enabled = true;6768Array _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;6970const Vector2 SMALL_VEC2 = Vector2(CMP_EPSILON, CMP_EPSILON);71const Vector3 SMALL_VEC3 = Vector3(CMP_EPSILON, CMP_EPSILON, CMP_EPSILON);7273virtual TypedArray<StringName> _global_shader_parameter_get_list() const;7475protected:76RID _make_test_cube();77void _free_internal_rids();78RID test_texture;79RID white_texture;80RID test_material;8182Error _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);8384static RenderingServer *(*create_func)();85static void _bind_methods();8687#ifndef DISABLE_DEPRECATED88void _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);89void _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);90void _canvas_item_add_rect_bind_compat_84523(RID p_item, const Rect2 &p_rect, const Color &p_color);91void _canvas_item_add_circle_bind_compat_84523(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color);92void _instance_set_interpolated_bind_compat_104269(RID p_instance, bool p_interpolated);93void _instance_reset_physics_interpolation_bind_compat_104269(RID p_instance);9495static void _bind_compatibility_methods();96#endif9798public:99static RenderingServer *get_singleton();100static RenderingServer *create();101102enum {103NO_INDEX_ARRAY = -1,104ARRAY_WEIGHTS_SIZE = 4,105CANVAS_ITEM_Z_MIN = -4096,106CANVAS_ITEM_Z_MAX = 4096,107CANVAS_LAYER_MIN = -2147483648,108CANVAS_LAYER_MAX = 2147483647,109MAX_GLOW_LEVELS = 7,110MAX_CURSORS = 8,111MAX_2D_DIRECTIONAL_LIGHTS = 8,112MAX_MESH_SURFACES = 256113};114115/* TEXTURE API */116117enum TextureType {118TEXTURE_TYPE_2D,119TEXTURE_TYPE_LAYERED,120TEXTURE_TYPE_3D,121};122123enum TextureLayeredType {124TEXTURE_LAYERED_2D_ARRAY,125TEXTURE_LAYERED_CUBEMAP,126TEXTURE_LAYERED_CUBEMAP_ARRAY,127};128129enum CubeMapLayer {130CUBEMAP_LAYER_LEFT,131CUBEMAP_LAYER_RIGHT,132CUBEMAP_LAYER_BOTTOM,133CUBEMAP_LAYER_TOP,134CUBEMAP_LAYER_FRONT,135CUBEMAP_LAYER_BACK136};137138enum TextureDrawableFormat {139TEXTURE_DRAWABLE_FORMAT_RGBA8,140TEXTURE_DRAWABLE_FORMAT_RGBA8_SRGB, // Use this if you want to read the result from both 2D (non-hdr) and 3D.141TEXTURE_DRAWABLE_FORMAT_RGBAH,142TEXTURE_DRAWABLE_FORMAT_RGBAF,143};144145virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;146virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, TextureLayeredType p_layered_type) = 0;147virtual 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 coherent148virtual RID texture_external_create(int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;149virtual RID texture_proxy_create(RID p_base) = 0;150virtual RID texture_drawable_create(int p_width, int p_height, TextureDrawableFormat p_format, const Color &p_color = Color(1, 1, 1, 1), bool p_with_mipmaps = false) = 0;151152virtual 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;153154virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;155virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;156virtual void texture_external_update(RID p_texture, int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;157virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;158159virtual void texture_drawable_blit_rect(const TypedArray<RID> &p_textures, const Rect2i &p_rect, RID p_material, const Color &p_modulate, const TypedArray<RID> &p_source_textures, int p_to_mipmap = 0) = 0;160161// These two APIs can be used together or in combination with the others.162virtual RID texture_2d_placeholder_create() = 0;163virtual RID texture_2d_layered_placeholder_create(TextureLayeredType p_layered_type) = 0;164virtual RID texture_3d_placeholder_create() = 0;165166virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;167virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;168virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;169170virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;171virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;172173virtual void texture_set_path(RID p_texture, const String &p_path) = 0;174virtual String texture_get_path(RID p_texture) const = 0;175176virtual void texture_drawable_generate_mipmaps(RID p_texture) = 0; // Update mipmaps if modified177virtual RID texture_drawable_get_default_material() const = 0; // To use with simplified functions in DrawableTexture2D178179virtual Image::Format texture_get_format(RID p_texture) const = 0;180181typedef void (*TextureDetectCallback)(void *);182183virtual void texture_set_detect_3d_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;184virtual void texture_set_detect_normal_callback(RID p_texture, TextureDetectCallback p_callback, void *p_userdata) = 0;185186enum TextureDetectRoughnessChannel {187TEXTURE_DETECT_ROUGHNESS_R,188TEXTURE_DETECT_ROUGHNESS_G,189TEXTURE_DETECT_ROUGHNESS_B,190TEXTURE_DETECT_ROUGHNESS_A,191TEXTURE_DETECT_ROUGHNESS_GRAY,192};193194typedef void (*TextureDetectRoughnessCallback)(void *, const String &, TextureDetectRoughnessChannel);195virtual void texture_set_detect_roughness_callback(RID p_texture, TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;196197struct TextureInfo {198RID texture;199uint32_t width;200uint32_t height;201uint32_t depth;202Image::Format format;203int64_t bytes;204String path;205TextureType type;206};207208virtual void texture_debug_usage(List<TextureInfo> *r_info) = 0;209Array _texture_debug_usage_bind();210211virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;212213virtual RID texture_rd_create(const RID &p_rd_texture, const RenderingServer::TextureLayeredType p_layer_type = RenderingServer::TEXTURE_LAYERED_2D_ARRAY) = 0;214virtual RID texture_get_rd_texture(RID p_texture, bool p_srgb = false) const = 0;215virtual uint64_t texture_get_native_handle(RID p_texture, bool p_srgb = false) const = 0;216217/* PIPELINES API */218219enum PipelineSource {220PIPELINE_SOURCE_CANVAS,221PIPELINE_SOURCE_MESH,222PIPELINE_SOURCE_SURFACE,223PIPELINE_SOURCE_DRAW,224PIPELINE_SOURCE_SPECIALIZATION,225PIPELINE_SOURCE_MAX226};227228/* SHADER API */229230enum ShaderMode {231SHADER_SPATIAL,232SHADER_CANVAS_ITEM,233SHADER_PARTICLES,234SHADER_SKY,235SHADER_FOG,236SHADER_TEXTURE_BLIT,237SHADER_MAX238};239240enum CullMode {241CULL_MODE_DISABLED,242CULL_MODE_FRONT,243CULL_MODE_BACK,244};245246virtual RID shader_create() = 0;247virtual RID shader_create_from_code(const String &p_code, const String &p_path_hint = String()) = 0;248249virtual void shader_set_code(RID p_shader, const String &p_code) = 0;250virtual void shader_set_path_hint(RID p_shader, const String &p_path) = 0;251virtual String shader_get_code(RID p_shader) const = 0;252virtual void get_shader_parameter_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;253virtual Variant shader_get_parameter_default(RID p_shader, const StringName &p_param) const = 0;254255virtual void shader_set_default_texture_parameter(RID p_shader, const StringName &p_name, RID p_texture, int p_index = 0) = 0;256virtual RID shader_get_default_texture_parameter(RID p_shader, const StringName &p_name, int p_index = 0) const = 0;257258struct ShaderNativeSourceCode {259struct Version {260struct Stage {261String name;262String code;263};264Vector<Stage> stages;265};266Vector<Version> versions;267};268269virtual ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;270271/* COMMON MATERIAL API */272273enum {274MATERIAL_RENDER_PRIORITY_MIN = -128,275MATERIAL_RENDER_PRIORITY_MAX = 127,276};277278virtual RID material_create() = 0;279virtual RID material_create_from_shader(RID p_next_pass, int p_render_priority, RID p_shader) = 0;280281virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;282283virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;284virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;285286virtual void material_set_render_priority(RID p_material, int priority) = 0;287288virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;289290virtual void material_set_use_debanding(bool p_enable) = 0;291292/* MESH API */293294enum ArrayType {295ARRAY_VERTEX = 0, // RG32F (2D), RGB32F, RGBA16 (compressed)296ARRAY_NORMAL = 1, // RG16297ARRAY_TANGENT = 2, // BA16 (with normal) or A16 (with vertex, when compressed)298ARRAY_COLOR = 3, // RGBA8299ARRAY_TEX_UV = 4, // RG32F or RG16300ARRAY_TEX_UV2 = 5, // RG32F or RG16301ARRAY_CUSTOM0 = 6, // Depends on ArrayCustomFormat.302ARRAY_CUSTOM1 = 7,303ARRAY_CUSTOM2 = 8,304ARRAY_CUSTOM3 = 9,305ARRAY_BONES = 10, // RGBA16UI (x2 if 8 weights)306ARRAY_WEIGHTS = 11, // RGBA16UNORM (x2 if 8 weights)307ARRAY_INDEX = 12, // 16 or 32 bits depending on length > 0xFFFF.308ARRAY_MAX = 13309};310311enum {312ARRAY_CUSTOM_COUNT = ARRAY_BONES - ARRAY_CUSTOM0313};314315enum ArrayCustomFormat {316ARRAY_CUSTOM_RGBA8_UNORM,317ARRAY_CUSTOM_RGBA8_SNORM,318ARRAY_CUSTOM_RG_HALF,319ARRAY_CUSTOM_RGBA_HALF,320ARRAY_CUSTOM_R_FLOAT,321ARRAY_CUSTOM_RG_FLOAT,322ARRAY_CUSTOM_RGB_FLOAT,323ARRAY_CUSTOM_RGBA_FLOAT,324ARRAY_CUSTOM_MAX325};326327enum ArrayFormat : uint64_t {328/* ARRAY FORMAT FLAGS */329ARRAY_FORMAT_VERTEX = 1 << ARRAY_VERTEX,330ARRAY_FORMAT_NORMAL = 1 << ARRAY_NORMAL,331ARRAY_FORMAT_TANGENT = 1 << ARRAY_TANGENT,332ARRAY_FORMAT_COLOR = 1 << ARRAY_COLOR,333ARRAY_FORMAT_TEX_UV = 1 << ARRAY_TEX_UV,334ARRAY_FORMAT_TEX_UV2 = 1 << ARRAY_TEX_UV2,335ARRAY_FORMAT_CUSTOM0 = 1 << ARRAY_CUSTOM0,336ARRAY_FORMAT_CUSTOM1 = 1 << ARRAY_CUSTOM1,337ARRAY_FORMAT_CUSTOM2 = 1 << ARRAY_CUSTOM2,338ARRAY_FORMAT_CUSTOM3 = 1 << ARRAY_CUSTOM3,339ARRAY_FORMAT_BONES = 1 << ARRAY_BONES,340ARRAY_FORMAT_WEIGHTS = 1 << ARRAY_WEIGHTS,341ARRAY_FORMAT_INDEX = 1 << ARRAY_INDEX,342343ARRAY_FORMAT_BLEND_SHAPE_MASK = ARRAY_FORMAT_VERTEX | ARRAY_FORMAT_NORMAL | ARRAY_FORMAT_TANGENT,344345ARRAY_FORMAT_CUSTOM_BASE = (ARRAY_INDEX + 1),346ARRAY_FORMAT_CUSTOM_BITS = 3,347ARRAY_FORMAT_CUSTOM_MASK = 0x7,348ARRAY_FORMAT_CUSTOM0_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + 0),349ARRAY_FORMAT_CUSTOM1_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS),350ARRAY_FORMAT_CUSTOM2_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 2),351ARRAY_FORMAT_CUSTOM3_SHIFT = (ARRAY_FORMAT_CUSTOM_BASE + ARRAY_FORMAT_CUSTOM_BITS * 3),352353ARRAY_COMPRESS_FLAGS_BASE = (ARRAY_INDEX + 1 + 12),354355ARRAY_FLAG_USE_2D_VERTICES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 0),356ARRAY_FLAG_USE_DYNAMIC_UPDATE = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 1),357ARRAY_FLAG_USE_8_BONE_WEIGHTS = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 2),358359ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 3),360361ARRAY_FLAG_COMPRESS_ATTRIBUTES = 1 << (ARRAY_COMPRESS_FLAGS_BASE + 4),362// We leave enough room for up to 5 more compression flags.363364ARRAY_FLAG_FORMAT_VERSION_BASE = ARRAY_COMPRESS_FLAGS_BASE + 10,365ARRAY_FLAG_FORMAT_VERSION_SHIFT = ARRAY_FLAG_FORMAT_VERSION_BASE,366// When changes are made to the mesh format, add a new version and use it for the CURRENT_VERSION.367ARRAY_FLAG_FORMAT_VERSION_1 = 0,368ARRAY_FLAG_FORMAT_VERSION_2 = 1ULL << ARRAY_FLAG_FORMAT_VERSION_SHIFT,369ARRAY_FLAG_FORMAT_CURRENT_VERSION = ARRAY_FLAG_FORMAT_VERSION_2,370ARRAY_FLAG_FORMAT_VERSION_MASK = 0xFF, // 8 bits version371};372373static_assert(sizeof(ArrayFormat) == 8, "ArrayFormat should be 64 bits long.");374375enum PrimitiveType {376PRIMITIVE_POINTS,377PRIMITIVE_LINES,378PRIMITIVE_LINE_STRIP,379PRIMITIVE_TRIANGLES,380PRIMITIVE_TRIANGLE_STRIP,381PRIMITIVE_MAX,382};383384struct SurfaceData {385PrimitiveType primitive = PRIMITIVE_MAX;386387uint64_t format = ARRAY_FLAG_FORMAT_CURRENT_VERSION;388Vector<uint8_t> vertex_data; // Vertex, Normal, Tangent (change with skinning, blendshape).389Vector<uint8_t> attribute_data; // Color, UV, UV2, Custom0-3.390Vector<uint8_t> skin_data; // Bone index, Bone weight.391uint32_t vertex_count = 0;392Vector<uint8_t> index_data;393uint32_t index_count = 0;394395AABB aabb;396struct LOD {397float edge_length = 0.0f;398Vector<uint8_t> index_data;399};400Vector<LOD> lods;401Vector<AABB> bone_aabbs;402403// Transforms used in runtime bone AABBs compute.404// Since bone AABBs is saved in Mesh space, but bones is in Skeleton space.405Transform3D mesh_to_skeleton_xform;406407Vector<uint8_t> blend_shape_data;408409Vector4 uv_scale;410411RID material;412};413414virtual RID mesh_create_from_surfaces(const Vector<SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;415virtual RID mesh_create() = 0;416417virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;418419virtual uint32_t mesh_surface_get_format_offset(BitField<ArrayFormat> p_format, int p_vertex_len, int p_array_index) const;420virtual uint32_t mesh_surface_get_format_vertex_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;421virtual uint32_t mesh_surface_get_format_normal_tangent_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;422virtual uint32_t mesh_surface_get_format_attribute_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;423virtual uint32_t mesh_surface_get_format_skin_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;424virtual uint32_t mesh_surface_get_format_index_stride(BitField<ArrayFormat> p_format, int p_vertex_len) const;425426/// Returns stride427virtual 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;428virtual 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);429Array mesh_create_arrays_from_surface_data(const SurfaceData &p_data) const;430Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;431TypedArray<Array> mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;432Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;433434virtual 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);435virtual void mesh_add_surface(RID p_mesh, const SurfaceData &p_surface) = 0;436437virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;438439enum BlendShapeMode {440BLEND_SHAPE_MODE_NORMALIZED,441BLEND_SHAPE_MODE_RELATIVE,442};443444virtual void mesh_set_blend_shape_mode(RID p_mesh, BlendShapeMode p_mode) = 0;445virtual BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;446447virtual void mesh_surface_update_vertex_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;448virtual void mesh_surface_update_attribute_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;449virtual void mesh_surface_update_skin_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;450virtual void mesh_surface_update_index_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;451452virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;453virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;454455virtual SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;456457virtual int mesh_get_surface_count(RID p_mesh) const = 0;458459virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;460virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;461462virtual void mesh_set_path(RID p_mesh, const String &p_path) = 0;463virtual String mesh_get_path(RID p_mesh) const = 0;464465virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;466467virtual void mesh_surface_remove(RID p_mesh, int p_surface) = 0;468virtual void mesh_clear(RID p_mesh) = 0;469470struct MeshInfo {471RID mesh;472String path;473uint32_t vertex_buffer_size = 0;474uint32_t attribute_buffer_size = 0;475uint32_t skin_buffer_size = 0;476uint32_t index_buffer_size = 0;477uint32_t blend_shape_buffer_size = 0;478uint32_t lod_index_buffers_size = 0;479uint64_t vertex_count = 0;480};481482virtual void mesh_debug_usage(List<MeshInfo> *r_info) = 0;483484/* MULTIMESH API */485486virtual RID multimesh_create() = 0;487488enum MultimeshTransformFormat {489MULTIMESH_TRANSFORM_2D,490MULTIMESH_TRANSFORM_3D,491};492493enum MultimeshPhysicsInterpolationQuality {494MULTIMESH_INTERP_QUALITY_FAST,495MULTIMESH_INTERP_QUALITY_HIGH,496};497498protected:499#ifndef DISABLE_DEPRECATED500void _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);501#endif502public:503virtual 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;504virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;505506virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;507virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform3D &p_transform) = 0;508virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;509virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;510virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;511512virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;513virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;514515virtual void multimesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;516virtual AABB multimesh_get_custom_aabb(RID p_mesh) const = 0;517518virtual Transform3D multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;519virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;520virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;521virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;522523virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;524virtual RID multimesh_get_command_buffer_rd_rid(RID p_multimesh) const = 0;525virtual RID multimesh_get_buffer_rd_rid(RID p_multimesh) const = 0;526virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;527528// Interpolation.529virtual void multimesh_set_buffer_interpolated(RID p_multimesh, const Vector<float> &p_buffer_curr, const Vector<float> &p_buffer_prev) = 0;530virtual void multimesh_set_physics_interpolated(RID p_multimesh, bool p_interpolated) = 0;531virtual void multimesh_set_physics_interpolation_quality(RID p_multimesh, MultimeshPhysicsInterpolationQuality p_quality) = 0;532virtual void multimesh_instance_reset_physics_interpolation(RID p_multimesh, int p_index) = 0;533virtual void multimesh_instances_reset_physics_interpolation(RID p_multimesh) = 0;534535virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;536virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;537538/* SKELETON API */539540virtual RID skeleton_create() = 0;541virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;542virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;543virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform3D &p_transform) = 0;544virtual Transform3D skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;545virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;546virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;547virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;548549/* Light API */550551enum LightType {552LIGHT_DIRECTIONAL,553LIGHT_OMNI,554LIGHT_SPOT555};556557enum LightParam {558LIGHT_PARAM_ENERGY,559LIGHT_PARAM_INDIRECT_ENERGY,560LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY,561LIGHT_PARAM_SPECULAR,562LIGHT_PARAM_RANGE,563LIGHT_PARAM_SIZE,564LIGHT_PARAM_ATTENUATION,565LIGHT_PARAM_SPOT_ANGLE,566LIGHT_PARAM_SPOT_ATTENUATION,567LIGHT_PARAM_SHADOW_MAX_DISTANCE,568LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET,569LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET,570LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET,571LIGHT_PARAM_SHADOW_FADE_START,572LIGHT_PARAM_SHADOW_NORMAL_BIAS,573LIGHT_PARAM_SHADOW_BIAS,574LIGHT_PARAM_SHADOW_PANCAKE_SIZE,575LIGHT_PARAM_SHADOW_OPACITY,576LIGHT_PARAM_SHADOW_BLUR,577LIGHT_PARAM_TRANSMITTANCE_BIAS,578LIGHT_PARAM_INTENSITY,579LIGHT_PARAM_MAX580};581582virtual RID directional_light_create() = 0;583virtual RID omni_light_create() = 0;584virtual RID spot_light_create() = 0;585586virtual void light_set_color(RID p_light, const Color &p_color) = 0;587virtual void light_set_param(RID p_light, LightParam p_param, float p_value) = 0;588virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;589virtual void light_set_projector(RID p_light, RID p_texture) = 0;590virtual void light_set_negative(RID p_light, bool p_enable) = 0;591virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;592virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;593virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;594virtual void light_set_shadow_caster_mask(RID p_light, uint32_t p_caster_mask) = 0;595596enum LightBakeMode {597LIGHT_BAKE_DISABLED,598LIGHT_BAKE_STATIC,599LIGHT_BAKE_DYNAMIC,600};601602virtual void light_set_bake_mode(RID p_light, LightBakeMode p_bake_mode) = 0;603virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;604605// Omni light606enum LightOmniShadowMode {607LIGHT_OMNI_SHADOW_DUAL_PARABOLOID,608LIGHT_OMNI_SHADOW_CUBE,609};610611virtual void light_omni_set_shadow_mode(RID p_light, LightOmniShadowMode p_mode) = 0;612613// Directional light614enum LightDirectionalShadowMode {615LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL,616LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS,617LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS,618};619620enum LightDirectionalSkyMode {621LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY,622LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY,623LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY,624};625626virtual void light_directional_set_shadow_mode(RID p_light, LightDirectionalShadowMode p_mode) = 0;627virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;628virtual void light_directional_set_sky_mode(RID p_light, LightDirectionalSkyMode p_mode) = 0;629630// Shadow atlas631632virtual RID shadow_atlas_create() = 0;633virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;634virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;635636virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;637638enum ShadowQuality {639SHADOW_QUALITY_HARD,640SHADOW_QUALITY_SOFT_VERY_LOW,641SHADOW_QUALITY_SOFT_LOW,642SHADOW_QUALITY_SOFT_MEDIUM,643SHADOW_QUALITY_SOFT_HIGH,644SHADOW_QUALITY_SOFT_ULTRA,645SHADOW_QUALITY_MAX646};647648virtual void positional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;649virtual void directional_soft_shadow_filter_set_quality(ShadowQuality p_quality) = 0;650651enum LightProjectorFilter {652LIGHT_PROJECTOR_FILTER_NEAREST,653LIGHT_PROJECTOR_FILTER_LINEAR,654LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS,655LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS,656LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,657LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,658};659660virtual void light_projectors_set_filter(LightProjectorFilter p_filter) = 0;661662/* PROBE API */663664virtual RID reflection_probe_create() = 0;665666enum ReflectionProbeUpdateMode {667REFLECTION_PROBE_UPDATE_ONCE,668REFLECTION_PROBE_UPDATE_ALWAYS,669};670671virtual void reflection_probe_set_update_mode(RID p_probe, ReflectionProbeUpdateMode p_mode) = 0;672virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;673virtual void reflection_probe_set_blend_distance(RID p_probe, float p_blend_distance) = 0;674675enum ReflectionProbeAmbientMode {676REFLECTION_PROBE_AMBIENT_DISABLED,677REFLECTION_PROBE_AMBIENT_ENVIRONMENT,678REFLECTION_PROBE_AMBIENT_COLOR,679};680681virtual void reflection_probe_set_ambient_mode(RID p_probe, ReflectionProbeAmbientMode p_mode) = 0;682virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;683virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;684virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;685virtual void reflection_probe_set_size(RID p_probe, const Vector3 &p_size) = 0;686virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;687virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;688virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;689virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;690virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;691virtual void reflection_probe_set_reflection_mask(RID p_probe, uint32_t p_layers) = 0;692virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;693virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_pixels) = 0;694695/* DECAL API */696697enum DecalTexture {698DECAL_TEXTURE_ALBEDO,699DECAL_TEXTURE_NORMAL,700DECAL_TEXTURE_ORM,701DECAL_TEXTURE_EMISSION,702DECAL_TEXTURE_MAX703};704705virtual RID decal_create() = 0;706virtual void decal_set_size(RID p_decal, const Vector3 &p_size) = 0;707virtual void decal_set_texture(RID p_decal, DecalTexture p_type, RID p_texture) = 0;708virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;709virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;710virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;711virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;712virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;713virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;714virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;715716enum DecalFilter {717DECAL_FILTER_NEAREST,718DECAL_FILTER_LINEAR,719DECAL_FILTER_NEAREST_MIPMAPS,720DECAL_FILTER_LINEAR_MIPMAPS,721DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC,722DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC,723};724725virtual void decals_set_filter(DecalFilter p_quality) = 0;726727/* VOXEL GI API */728729virtual RID voxel_gi_create() = 0;730731virtual 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;732733virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;734virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;735virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;736virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;737virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;738virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;739virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;740741virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;742virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;743virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;744virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;745virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;746virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;747virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;748virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;749750enum VoxelGIQuality {751VOXEL_GI_QUALITY_LOW,752VOXEL_GI_QUALITY_HIGH,753};754755virtual void voxel_gi_set_quality(VoxelGIQuality) = 0;756757virtual void sdfgi_reset() = 0;758759/* LIGHTMAP */760761enum ShadowmaskMode {762SHADOWMASK_MODE_NONE,763SHADOWMASK_MODE_REPLACE,764SHADOWMASK_MODE_OVERLAY,765SHADOWMASK_MODE_ONLY,766};767768virtual RID lightmap_create() = 0;769770virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;771virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;772virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;773virtual 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;774virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;775virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;776virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;777virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;778virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;779780virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;781virtual void lightmaps_set_bicubic_filter(bool p_enable) = 0;782783virtual void lightmap_set_shadowmask_textures(RID p_lightmap, RID p_shadow) = 0;784virtual ShadowmaskMode lightmap_get_shadowmask_mode(RID p_lightmap) = 0;785virtual void lightmap_set_shadowmask_mode(RID p_lightmap, ShadowmaskMode p_mode) = 0;786787/* PARTICLES API */788789virtual RID particles_create() = 0;790791enum ParticlesMode {792PARTICLES_MODE_2D,793PARTICLES_MODE_3D794};795virtual void particles_set_mode(RID p_particles, ParticlesMode p_mode) = 0;796797virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;798virtual bool particles_get_emitting(RID p_particles) = 0;799virtual void particles_set_amount(RID p_particles, int p_amount) = 0;800virtual void particles_set_amount_ratio(RID p_particles, float p_amount_ratio) = 0;801virtual void particles_set_lifetime(RID p_particles, double p_lifetime) = 0;802virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;803virtual void particles_set_pre_process_time(RID p_particles, double p_time) = 0;804virtual void particles_request_process_time(RID p_particles, real_t p_request_process_time) = 0;805virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;806virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;807virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;808virtual void particles_set_speed_scale(RID p_particles, double p_scale) = 0;809virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;810virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;811virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;812virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;813virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;814virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;815virtual void particles_set_seed(RID p_particles, uint32_t p_seed) = 0;816817enum ParticlesTransformAlign {818PARTICLES_TRANSFORM_ALIGN_DISABLED,819PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD,820PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY,821PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY,822};823824virtual void particles_set_transform_align(RID p_particles, ParticlesTransformAlign p_transform_align) = 0;825826virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;827virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) = 0;828829virtual bool particles_is_inactive(RID p_particles) = 0;830virtual void particles_request_process(RID p_particles) = 0;831virtual void particles_restart(RID p_particles) = 0;832833virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;834835enum ParticlesEmitFlags {836PARTICLES_EMIT_FLAG_POSITION = 1,837PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2,838PARTICLES_EMIT_FLAG_VELOCITY = 4,839PARTICLES_EMIT_FLAG_COLOR = 8,840PARTICLES_EMIT_FLAG_CUSTOM = 16841};842843virtual 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;844845enum ParticlesDrawOrder {846PARTICLES_DRAW_ORDER_INDEX,847PARTICLES_DRAW_ORDER_LIFETIME,848PARTICLES_DRAW_ORDER_REVERSE_LIFETIME,849PARTICLES_DRAW_ORDER_VIEW_DEPTH,850};851852virtual void particles_set_draw_order(RID p_particles, ParticlesDrawOrder p_order) = 0;853854virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;855virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;856857virtual AABB particles_get_current_aabb(RID p_particles) = 0;858859virtual void particles_set_emission_transform(RID p_particles, const Transform3D &p_transform) = 0; // This is only used for 2D, in 3D it's automatic.860virtual void particles_set_emitter_velocity(RID p_particles, const Vector3 &p_velocity) = 0;861virtual void particles_set_interp_to_end(RID p_particles, float p_interp) = 0;862863/* PARTICLES COLLISION API */864865virtual RID particles_collision_create() = 0;866867enum ParticlesCollisionType {868PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT,869PARTICLES_COLLISION_TYPE_BOX_ATTRACT,870PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT,871PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE,872PARTICLES_COLLISION_TYPE_BOX_COLLIDE,873PARTICLES_COLLISION_TYPE_SDF_COLLIDE,874PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE,875};876877virtual void particles_collision_set_collision_type(RID p_particles_collision, ParticlesCollisionType p_type) = 0;878virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;879virtual void particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) = 0; // For spheres.880virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; // For non-spheres.881virtual void particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) = 0;882virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) = 0;883virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) = 0;884virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; // For SDF and vector field, heightfield is dynamic.885886virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; // For SDF and vector field.887888enum ParticlesCollisionHeightfieldResolution { // Longest axis resolution.889PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256,890PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512,891PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024,892PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048,893PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096,894PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192,895PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX,896};897898virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, ParticlesCollisionHeightfieldResolution p_resolution) = 0; // For SDF and vector field.899virtual void particles_collision_set_height_field_mask(RID p_particles_collision, uint32_t p_heightfield_mask) = 0;900901/* FOG VOLUME API */902903virtual RID fog_volume_create() = 0;904905enum FogVolumeShape {906FOG_VOLUME_SHAPE_ELLIPSOID,907FOG_VOLUME_SHAPE_CONE,908FOG_VOLUME_SHAPE_CYLINDER,909FOG_VOLUME_SHAPE_BOX,910FOG_VOLUME_SHAPE_WORLD,911FOG_VOLUME_SHAPE_MAX,912};913914virtual void fog_volume_set_shape(RID p_fog_volume, FogVolumeShape p_shape) = 0;915virtual void fog_volume_set_size(RID p_fog_volume, const Vector3 &p_size) = 0;916virtual void fog_volume_set_material(RID p_fog_volume, RID p_material) = 0;917918/* VISIBILITY NOTIFIER API */919920virtual RID visibility_notifier_create() = 0;921virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) = 0;922virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;923924/* OCCLUDER API */925926virtual RID occluder_create() = 0;927virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;928929/* CAMERA API */930931virtual RID camera_create() = 0;932virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;933virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;934virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;935virtual void camera_set_transform(RID p_camera, const Transform3D &p_transform) = 0;936virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;937virtual void camera_set_environment(RID p_camera, RID p_env) = 0;938virtual void camera_set_camera_attributes(RID p_camera, RID p_camera_attributes) = 0;939virtual void camera_set_compositor(RID p_camera, RID p_compositor) = 0;940virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;941942/* VIEWPORT API */943944enum CanvasItemTextureFilter {945CANVAS_ITEM_TEXTURE_FILTER_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.946CANVAS_ITEM_TEXTURE_FILTER_NEAREST,947CANVAS_ITEM_TEXTURE_FILTER_LINEAR,948CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS,949CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS,950CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC,951CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC,952CANVAS_ITEM_TEXTURE_FILTER_MAX953};954955enum CanvasItemTextureRepeat {956CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT, // Uses canvas item setting for draw command, uses global setting for canvas item.957CANVAS_ITEM_TEXTURE_REPEAT_DISABLED,958CANVAS_ITEM_TEXTURE_REPEAT_ENABLED,959CANVAS_ITEM_TEXTURE_REPEAT_MIRROR,960CANVAS_ITEM_TEXTURE_REPEAT_MAX,961};962963virtual RID viewport_create() = 0;964965enum ViewportScaling3DMode {966VIEWPORT_SCALING_3D_MODE_BILINEAR,967VIEWPORT_SCALING_3D_MODE_FSR,968VIEWPORT_SCALING_3D_MODE_FSR2,969VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL,970VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL,971VIEWPORT_SCALING_3D_MODE_MAX,972VIEWPORT_SCALING_3D_MODE_OFF = 255, // for internal use only973};974975enum ViewportAnisotropicFiltering {976VIEWPORT_ANISOTROPY_DISABLED,977VIEWPORT_ANISOTROPY_2X,978VIEWPORT_ANISOTROPY_4X,979VIEWPORT_ANISOTROPY_8X,980VIEWPORT_ANISOTROPY_16X,981VIEWPORT_ANISOTROPY_MAX982};983984enum ViewportScaling3DType {985VIEWPORT_SCALING_3D_TYPE_NONE,986VIEWPORT_SCALING_3D_TYPE_TEMPORAL,987VIEWPORT_SCALING_3D_TYPE_SPATIAL,988VIEWPORT_SCALING_3D_TYPE_MAX,989};990991_ALWAYS_INLINE_ static ViewportScaling3DType scaling_3d_mode_type(ViewportScaling3DMode p_mode) {992if (p_mode == VIEWPORT_SCALING_3D_MODE_BILINEAR || p_mode == VIEWPORT_SCALING_3D_MODE_FSR || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL) {993return VIEWPORT_SCALING_3D_TYPE_SPATIAL;994} else if (p_mode == VIEWPORT_SCALING_3D_MODE_FSR2 || p_mode == VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL) {995return VIEWPORT_SCALING_3D_TYPE_TEMPORAL;996}997return VIEWPORT_SCALING_3D_TYPE_NONE;998}9991000#ifndef XR_DISABLED1001virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;1002#endif // !XR_DISABLED10031004virtual void viewport_set_size(RID p_viewport, int p_width, int p_height) = 0;1005virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;1006virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;1007virtual void viewport_set_canvas_cull_mask(RID p_viewport, uint32_t p_canvas_cull_mask) = 0;10081009virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServer::WindowID p_screen = DisplayServer::MAIN_WINDOW_ID) = 0;1010virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;10111012virtual void viewport_set_scaling_3d_mode(RID p_viewport, ViewportScaling3DMode p_scaling_3d_mode) = 0;1013virtual void viewport_set_scaling_3d_scale(RID p_viewport, float p_scaling_3d_scale) = 0;1014virtual void viewport_set_fsr_sharpness(RID p_viewport, float p_fsr_sharpness) = 0;1015virtual void viewport_set_texture_mipmap_bias(RID p_viewport, float p_texture_mipmap_bias) = 0;1016virtual void viewport_set_anisotropic_filtering_level(RID p_viewport, ViewportAnisotropicFiltering p_anisotropic_filtering_level) = 0;10171018enum ViewportUpdateMode {1019VIEWPORT_UPDATE_DISABLED,1020VIEWPORT_UPDATE_ONCE, // Then goes to disabled, must be manually updated.1021VIEWPORT_UPDATE_WHEN_VISIBLE, // Default1022VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE,1023VIEWPORT_UPDATE_ALWAYS1024};10251026virtual void viewport_set_update_mode(RID p_viewport, ViewportUpdateMode p_mode) = 0;1027virtual ViewportUpdateMode viewport_get_update_mode(RID p_viewport) const = 0;10281029enum ViewportClearMode {1030VIEWPORT_CLEAR_ALWAYS,1031VIEWPORT_CLEAR_NEVER,1032VIEWPORT_CLEAR_ONLY_NEXT_FRAME1033};10341035virtual void viewport_set_clear_mode(RID p_viewport, ViewportClearMode p_clear_mode) = 0;10361037virtual RID viewport_get_render_target(RID p_viewport) const = 0;1038virtual RID viewport_get_texture(RID p_viewport) const = 0;10391040enum ViewportEnvironmentMode {1041VIEWPORT_ENVIRONMENT_DISABLED,1042VIEWPORT_ENVIRONMENT_ENABLED,1043VIEWPORT_ENVIRONMENT_INHERIT,1044VIEWPORT_ENVIRONMENT_MAX,1045};10461047virtual void viewport_set_environment_mode(RID p_viewport, ViewportEnvironmentMode p_mode) = 0;1048virtual void viewport_set_disable_3d(RID p_viewport, bool p_disable) = 0;1049virtual void viewport_set_disable_2d(RID p_viewport, bool p_disable) = 0;10501051virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;1052virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;1053virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;1054virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;1055virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;1056virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;1057virtual void viewport_set_use_hdr_2d(RID p_viewport, bool p_use_hdr) = 0;1058virtual bool viewport_is_using_hdr_2d(RID p_viewport) const = 0;1059virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;1060virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;10611062virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, CanvasItemTextureFilter p_filter) = 0;1063virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, CanvasItemTextureRepeat p_repeat) = 0;10641065virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;1066virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;10671068enum ViewportSDFOversize {1069VIEWPORT_SDF_OVERSIZE_100_PERCENT,1070VIEWPORT_SDF_OVERSIZE_120_PERCENT,1071VIEWPORT_SDF_OVERSIZE_150_PERCENT,1072VIEWPORT_SDF_OVERSIZE_200_PERCENT,1073VIEWPORT_SDF_OVERSIZE_MAX1074};10751076enum ViewportSDFScale {1077VIEWPORT_SDF_SCALE_100_PERCENT,1078VIEWPORT_SDF_SCALE_50_PERCENT,1079VIEWPORT_SDF_SCALE_25_PERCENT,1080VIEWPORT_SDF_SCALE_MAX1081};10821083virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, ViewportSDFOversize p_oversize, ViewportSDFScale p_scale) = 0;10841085virtual void viewport_set_positional_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = true) = 0;1086virtual void viewport_set_positional_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;10871088enum ViewportMSAA {1089VIEWPORT_MSAA_DISABLED,1090VIEWPORT_MSAA_2X,1091VIEWPORT_MSAA_4X,1092VIEWPORT_MSAA_8X,1093VIEWPORT_MSAA_MAX,1094};10951096virtual void viewport_set_msaa_3d(RID p_viewport, ViewportMSAA p_msaa) = 0;1097virtual void viewport_set_msaa_2d(RID p_viewport, ViewportMSAA p_msaa) = 0;10981099enum ViewportScreenSpaceAA {1100VIEWPORT_SCREEN_SPACE_AA_DISABLED,1101VIEWPORT_SCREEN_SPACE_AA_FXAA,1102VIEWPORT_SCREEN_SPACE_AA_SMAA,1103VIEWPORT_SCREEN_SPACE_AA_MAX,1104};11051106virtual void viewport_set_screen_space_aa(RID p_viewport, ViewportScreenSpaceAA p_mode) = 0;11071108virtual void viewport_set_use_taa(RID p_viewport, bool p_use_taa) = 0;11091110virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;11111112virtual void viewport_set_force_motion_vectors(RID p_viewport, bool p_force_motion_vectors) = 0;11131114virtual void viewport_set_mesh_lod_threshold(RID p_viewport, float p_pixels) = 0;11151116virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling) = 0;1117virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;11181119enum ViewportOcclusionCullingBuildQuality {1120VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0,1121VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1,1122VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2,1123};11241125virtual void viewport_set_occlusion_culling_build_quality(ViewportOcclusionCullingBuildQuality p_quality) = 0;11261127enum ViewportRenderInfo {1128VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME,1129VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME,1130VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME,1131VIEWPORT_RENDER_INFO_MAX,1132};11331134enum ViewportRenderInfoType {1135VIEWPORT_RENDER_INFO_TYPE_VISIBLE,1136VIEWPORT_RENDER_INFO_TYPE_SHADOW,1137VIEWPORT_RENDER_INFO_TYPE_CANVAS,1138VIEWPORT_RENDER_INFO_TYPE_MAX1139};11401141virtual int viewport_get_render_info(RID p_viewport, ViewportRenderInfoType p_type, ViewportRenderInfo p_info) = 0;11421143enum ViewportDebugDraw {1144VIEWPORT_DEBUG_DRAW_DISABLED,1145VIEWPORT_DEBUG_DRAW_UNSHADED,1146VIEWPORT_DEBUG_DRAW_LIGHTING,1147VIEWPORT_DEBUG_DRAW_OVERDRAW,1148VIEWPORT_DEBUG_DRAW_WIREFRAME,1149VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER,1150VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO,1151VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING,1152VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION,1153VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS,1154VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS,1155VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE,1156VIEWPORT_DEBUG_DRAW_SSAO,1157VIEWPORT_DEBUG_DRAW_SSIL,1158VIEWPORT_DEBUG_DRAW_PSSM_SPLITS,1159VIEWPORT_DEBUG_DRAW_DECAL_ATLAS,1160VIEWPORT_DEBUG_DRAW_SDFGI,1161VIEWPORT_DEBUG_DRAW_SDFGI_PROBES,1162VIEWPORT_DEBUG_DRAW_GI_BUFFER,1163VIEWPORT_DEBUG_DRAW_DISABLE_LOD,1164VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS,1165VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS,1166VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS,1167VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES,1168VIEWPORT_DEBUG_DRAW_OCCLUDERS,1169VIEWPORT_DEBUG_DRAW_MOTION_VECTORS,1170VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER,1171};11721173virtual void viewport_set_debug_draw(RID p_viewport, ViewportDebugDraw p_draw) = 0;11741175virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;1176virtual double viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;1177virtual double viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;11781179virtual RID viewport_find_from_screen_attachment(DisplayServer::WindowID p_id = DisplayServer::MAIN_WINDOW_ID) const = 0;11801181enum ViewportVRSMode {1182VIEWPORT_VRS_DISABLED,1183VIEWPORT_VRS_TEXTURE,1184VIEWPORT_VRS_XR,1185VIEWPORT_VRS_MAX,1186};11871188enum ViewportVRSUpdateMode {1189VIEWPORT_VRS_UPDATE_DISABLED,1190VIEWPORT_VRS_UPDATE_ONCE,1191VIEWPORT_VRS_UPDATE_ALWAYS,1192VIEWPORT_VRS_UPDATE_MAX,1193};11941195virtual void viewport_set_vrs_mode(RID p_viewport, ViewportVRSMode p_mode) = 0;1196virtual void viewport_set_vrs_update_mode(RID p_viewport, ViewportVRSUpdateMode p_mode) = 0;1197virtual void viewport_set_vrs_texture(RID p_viewport, RID p_texture) = 0;11981199/* SKY API */12001201enum SkyMode {1202SKY_MODE_AUTOMATIC,1203SKY_MODE_QUALITY,1204SKY_MODE_INCREMENTAL,1205SKY_MODE_REALTIME1206};12071208virtual RID sky_create() = 0;1209virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;1210virtual void sky_set_mode(RID p_sky, SkyMode p_mode) = 0;1211virtual void sky_set_material(RID p_sky, RID p_material) = 0;1212virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;12131214/* COMPOSITOR EFFECTS API */12151216enum CompositorEffectFlags {1217COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR = 1,1218COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH = 2,1219COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS = 4,1220COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS = 8,1221COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR = 16,1222};12231224enum CompositorEffectCallbackType {1225COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE,1226COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE,1227COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY,1228COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT,1229COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT,1230COMPOSITOR_EFFECT_CALLBACK_TYPE_MAX,1231COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY = -1,1232};12331234virtual RID compositor_effect_create() = 0;1235virtual void compositor_effect_set_enabled(RID p_effect, bool p_enabled) = 0;1236virtual void compositor_effect_set_callback(RID p_effect, CompositorEffectCallbackType p_callback_type, const Callable &p_callback) = 0;1237virtual void compositor_effect_set_flag(RID p_effect, CompositorEffectFlags p_flag, bool p_set) = 0;12381239/* COMPOSITOR API */12401241virtual RID compositor_create() = 0;12421243virtual void compositor_set_compositor_effects(RID p_compositor, const TypedArray<RID> &p_effects) = 0;12441245/* ENVIRONMENT API */12461247virtual RID environment_create() = 0;12481249enum EnvironmentBG {1250ENV_BG_CLEAR_COLOR,1251ENV_BG_COLOR,1252ENV_BG_SKY,1253ENV_BG_CANVAS,1254ENV_BG_KEEP,1255ENV_BG_CAMERA_FEED,1256ENV_BG_MAX1257};12581259enum EnvironmentAmbientSource {1260ENV_AMBIENT_SOURCE_BG,1261ENV_AMBIENT_SOURCE_DISABLED,1262ENV_AMBIENT_SOURCE_COLOR,1263ENV_AMBIENT_SOURCE_SKY,1264};12651266enum EnvironmentReflectionSource {1267ENV_REFLECTION_SOURCE_BG,1268ENV_REFLECTION_SOURCE_DISABLED,1269ENV_REFLECTION_SOURCE_SKY,1270};12711272virtual void environment_set_background(RID p_env, EnvironmentBG p_bg) = 0;1273virtual void environment_set_sky(RID p_env, RID p_sky) = 0;1274virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;1275virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;1276virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;1277virtual void environment_set_bg_energy(RID p_env, float p_multiplier, float p_exposure_value) = 0;1278virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;1279virtual 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;1280virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;12811282enum EnvironmentGlowBlendMode {1283ENV_GLOW_BLEND_MODE_ADDITIVE,1284ENV_GLOW_BLEND_MODE_SCREEN,1285ENV_GLOW_BLEND_MODE_SOFTLIGHT,1286ENV_GLOW_BLEND_MODE_REPLACE,1287ENV_GLOW_BLEND_MODE_MIX,1288};12891290virtual 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;12911292virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;12931294enum EnvironmentToneMapper {1295ENV_TONE_MAPPER_LINEAR,1296ENV_TONE_MAPPER_REINHARD,1297ENV_TONE_MAPPER_FILMIC,1298ENV_TONE_MAPPER_ACES,1299ENV_TONE_MAPPER_AGX,1300};13011302virtual void environment_set_tonemap(RID p_env, EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white) = 0;1303virtual void environment_set_tonemap_agx_contrast(RID p_env, float p_agx_contrast) = 0;1304virtual 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;13051306virtual 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;13071308virtual void environment_set_ssr_half_size(bool p_half_size) = 0;13091310enum EnvironmentSSRRoughnessQuality {1311ENV_SSR_ROUGHNESS_QUALITY_DISABLED,1312ENV_SSR_ROUGHNESS_QUALITY_LOW,1313ENV_SSR_ROUGHNESS_QUALITY_MEDIUM,1314ENV_SSR_ROUGHNESS_QUALITY_HIGH,1315};13161317virtual void environment_set_ssr_roughness_quality(EnvironmentSSRRoughnessQuality p_quality) = 0;13181319virtual 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;13201321enum EnvironmentSSAOQuality {1322ENV_SSAO_QUALITY_VERY_LOW,1323ENV_SSAO_QUALITY_LOW,1324ENV_SSAO_QUALITY_MEDIUM,1325ENV_SSAO_QUALITY_HIGH,1326ENV_SSAO_QUALITY_ULTRA,1327};13281329virtual 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;13301331virtual void environment_set_ssil(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_sharpness, float p_normal_rejection) = 0;13321333enum EnvironmentSSILQuality {1334ENV_SSIL_QUALITY_VERY_LOW,1335ENV_SSIL_QUALITY_LOW,1336ENV_SSIL_QUALITY_MEDIUM,1337ENV_SSIL_QUALITY_HIGH,1338ENV_SSIL_QUALITY_ULTRA,1339};13401341virtual 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;13421343enum EnvironmentSDFGIYScale {1344ENV_SDFGI_Y_SCALE_50_PERCENT,1345ENV_SDFGI_Y_SCALE_75_PERCENT,1346ENV_SDFGI_Y_SCALE_100_PERCENT,1347};13481349virtual 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;13501351enum EnvironmentSDFGIRayCount {1352ENV_SDFGI_RAY_COUNT_4,1353ENV_SDFGI_RAY_COUNT_8,1354ENV_SDFGI_RAY_COUNT_16,1355ENV_SDFGI_RAY_COUNT_32,1356ENV_SDFGI_RAY_COUNT_64,1357ENV_SDFGI_RAY_COUNT_96,1358ENV_SDFGI_RAY_COUNT_128,1359ENV_SDFGI_RAY_COUNT_MAX,1360};13611362virtual void environment_set_sdfgi_ray_count(EnvironmentSDFGIRayCount p_ray_count) = 0;13631364enum EnvironmentSDFGIFramesToConverge {1365ENV_SDFGI_CONVERGE_IN_5_FRAMES,1366ENV_SDFGI_CONVERGE_IN_10_FRAMES,1367ENV_SDFGI_CONVERGE_IN_15_FRAMES,1368ENV_SDFGI_CONVERGE_IN_20_FRAMES,1369ENV_SDFGI_CONVERGE_IN_25_FRAMES,1370ENV_SDFGI_CONVERGE_IN_30_FRAMES,1371ENV_SDFGI_CONVERGE_MAX1372};13731374virtual void environment_set_sdfgi_frames_to_converge(EnvironmentSDFGIFramesToConverge p_frames) = 0;13751376enum EnvironmentSDFGIFramesToUpdateLight {1377ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME,1378ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES,1379ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES,1380ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES,1381ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES,1382ENV_SDFGI_UPDATE_LIGHT_MAX,1383};13841385virtual void environment_set_sdfgi_frames_to_update_light(EnvironmentSDFGIFramesToUpdateLight p_update) = 0;13861387enum EnvironmentFogMode {1388ENV_FOG_MODE_EXPONENTIAL,1389ENV_FOG_MODE_DEPTH,1390};13911392virtual 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;1393virtual void environment_set_fog_depth(RID p_env, float p_curve, float p_begin, float p_end) = 0;13941395virtual 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;1396virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;1397virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;13981399virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;14001401virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;14021403enum SubSurfaceScatteringQuality {1404SUB_SURFACE_SCATTERING_QUALITY_DISABLED,1405SUB_SURFACE_SCATTERING_QUALITY_LOW,1406SUB_SURFACE_SCATTERING_QUALITY_MEDIUM,1407SUB_SURFACE_SCATTERING_QUALITY_HIGH,1408};14091410virtual void sub_surface_scattering_set_quality(SubSurfaceScatteringQuality p_quality) = 0;1411virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;14121413/* CAMERA EFFECTS */14141415virtual RID camera_attributes_create() = 0;14161417enum DOFBlurQuality {1418DOF_BLUR_QUALITY_VERY_LOW,1419DOF_BLUR_QUALITY_LOW,1420DOF_BLUR_QUALITY_MEDIUM,1421DOF_BLUR_QUALITY_HIGH,1422};14231424virtual void camera_attributes_set_dof_blur_quality(DOFBlurQuality p_quality, bool p_use_jitter) = 0;14251426enum DOFBokehShape {1427DOF_BOKEH_BOX,1428DOF_BOKEH_HEXAGON,1429DOF_BOKEH_CIRCLE1430};14311432virtual void camera_attributes_set_dof_blur_bokeh_shape(DOFBokehShape p_shape) = 0;14331434virtual 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;1435virtual void camera_attributes_set_exposure(RID p_camera_attributes, float p_multiplier, float p_exposure_normalization) = 0;1436virtual 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;14371438/* SCENARIO API */14391440virtual RID scenario_create() = 0;14411442virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;1443virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;1444virtual void scenario_set_camera_attributes(RID p_scenario, RID p_camera_attributes) = 0;1445virtual void scenario_set_compositor(RID p_scenario, RID p_compositor) = 0;14461447/* INSTANCING API */14481449enum InstanceType {1450INSTANCE_NONE,1451INSTANCE_MESH,1452INSTANCE_MULTIMESH,1453INSTANCE_PARTICLES,1454INSTANCE_PARTICLES_COLLISION,1455INSTANCE_LIGHT,1456INSTANCE_REFLECTION_PROBE,1457INSTANCE_DECAL,1458INSTANCE_VOXEL_GI,1459INSTANCE_LIGHTMAP,1460INSTANCE_OCCLUDER,1461INSTANCE_VISIBLITY_NOTIFIER, // TODO: Fix typo in "VISIBILITY" (in 5.0).1462INSTANCE_FOG_VOLUME,1463INSTANCE_MAX,14641465INSTANCE_GEOMETRY_MASK = (1 << INSTANCE_MESH) | (1 << INSTANCE_MULTIMESH) | (1 << INSTANCE_PARTICLES)1466};14671468virtual RID instance_create2(RID p_base, RID p_scenario);14691470virtual RID instance_create() = 0;14711472virtual void instance_set_base(RID p_instance, RID p_base) = 0;1473virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;1474virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;1475virtual void instance_set_pivot_data(RID p_instance, float p_sorting_offset, bool p_use_aabb_center) = 0;1476virtual void instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;1477virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;1478virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;1479virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;1480virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;14811482virtual void instance_teleport(RID p_instance) = 0;14831484virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;14851486virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;14871488virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;1489virtual void instance_set_visibility_parent(RID p_instance, RID p_parent_instance) = 0;14901491virtual void instance_set_ignore_culling(RID p_instance, bool p_enabled) = 0;14921493// Don't use these in a game!1494virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;1495virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;1496virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;14971498PackedInt64Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;1499PackedInt64Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;1500PackedInt64Array _instances_cull_convex_bind(const TypedArray<Plane> &p_convex, RID p_scenario = RID()) const;15011502enum InstanceFlags {1503INSTANCE_FLAG_USE_BAKED_LIGHT,1504INSTANCE_FLAG_USE_DYNAMIC_GI,1505INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE,1506INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING,1507INSTANCE_FLAG_MAX1508};15091510enum ShadowCastingSetting {1511SHADOW_CASTING_SETTING_OFF,1512SHADOW_CASTING_SETTING_ON,1513SHADOW_CASTING_SETTING_DOUBLE_SIDED,1514SHADOW_CASTING_SETTING_SHADOWS_ONLY,1515};15161517enum VisibilityRangeFadeMode {1518VISIBILITY_RANGE_FADE_DISABLED,1519VISIBILITY_RANGE_FADE_SELF,1520VISIBILITY_RANGE_FADE_DEPENDENCIES,1521};15221523virtual void instance_geometry_set_flag(RID p_instance, InstanceFlags p_flags, bool p_enabled) = 0;1524virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, ShadowCastingSetting p_shadow_casting_setting) = 0;1525virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;1526virtual void instance_geometry_set_material_overlay(RID p_instance, RID p_material) = 0;1527virtual 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;1528virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;1529virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;1530virtual void instance_geometry_set_transparency(RID p_instance, float p_transparency) = 0;15311532virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;1533virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;1534virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;1535virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;15361537/* Bake 3D objects */15381539enum BakeChannels {1540BAKE_CHANNEL_ALBEDO_ALPHA,1541BAKE_CHANNEL_NORMAL,1542BAKE_CHANNEL_ORM,1543BAKE_CHANNEL_EMISSION1544};15451546virtual TypedArray<Image> bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size) = 0;15471548/* CANVAS (2D) */15491550virtual RID canvas_create() = 0;1551virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;1552virtual void canvas_set_item_repeat(RID p_item, const Point2 &p_repeat_size, int p_repeat_times) = 0;1553virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;1554virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;15551556virtual void canvas_set_disable_scale(bool p_disable) = 0;15571558/* CANVAS TEXTURE */1559virtual RID canvas_texture_create() = 0;15601561enum CanvasTextureChannel {1562CANVAS_TEXTURE_CHANNEL_DIFFUSE,1563CANVAS_TEXTURE_CHANNEL_NORMAL,1564CANVAS_TEXTURE_CHANNEL_SPECULAR,1565};1566virtual void canvas_texture_set_channel(RID p_canvas_texture, CanvasTextureChannel p_channel, RID p_texture) = 0;1567virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;15681569// Takes effect only for new draw commands.1570virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, CanvasItemTextureFilter p_filter) = 0;1571virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, CanvasItemTextureRepeat p_repeat) = 0;15721573/* CANVAS ITEM */15741575virtual RID canvas_item_create() = 0;1576virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;15771578virtual void canvas_item_set_default_texture_filter(RID p_item, CanvasItemTextureFilter p_filter) = 0;1579virtual void canvas_item_set_default_texture_repeat(RID p_item, CanvasItemTextureRepeat p_repeat) = 0;15801581virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;1582virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;15831584virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;15851586virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;1587virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;1588virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;1589virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;1590virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;1591virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;1592virtual void canvas_item_set_visibility_layer(RID p_item, uint32_t p_visibility_layer) = 0;15931594virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;1595virtual void canvas_item_set_use_identity_transform(RID p_item, bool p_enabled) = 0;15961597enum NinePatchAxisMode {1598NINE_PATCH_STRETCH,1599NINE_PATCH_TILE,1600NINE_PATCH_TILE_FIT,1601};16021603virtual 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;1604virtual 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;1605virtual 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;1606virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color, bool p_antialiased = false) = 0;1607virtual 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;1608virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color, bool p_antialiased = false) = 0;1609virtual 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;1610virtual 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;1611virtual 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;1612virtual 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;1613virtual 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;1614virtual 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;1615virtual 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;1616virtual 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;1617virtual 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;1618virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;1619virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;1620virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;1621virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;1622virtual 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;16231624virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;1625virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;1626virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;1627virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;16281629virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;16301631virtual void canvas_item_clear(RID p_item) = 0;1632virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;16331634virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;16351636virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;16371638virtual void canvas_item_set_instance_shader_parameter(RID p_item, const StringName &, const Variant &p_value) = 0;1639virtual Variant canvas_item_get_instance_shader_parameter(RID p_item, const StringName &) const = 0;1640virtual Variant canvas_item_get_instance_shader_parameter_default_value(RID p_item, const StringName &) const = 0;1641virtual void canvas_item_get_instance_shader_parameter_list(RID p_item, List<PropertyInfo> *p_parameters) const = 0;16421643virtual 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;16441645enum CanvasGroupMode {1646CANVAS_GROUP_MODE_DISABLED,1647CANVAS_GROUP_MODE_CLIP_ONLY,1648CANVAS_GROUP_MODE_CLIP_AND_DRAW,1649CANVAS_GROUP_MODE_TRANSPARENT,1650};16511652virtual 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;16531654virtual void canvas_item_set_debug_redraw(bool p_enabled) = 0;1655virtual bool canvas_item_get_debug_redraw() const = 0;16561657virtual void canvas_item_set_interpolated(RID p_item, bool p_interpolated) = 0;1658virtual void canvas_item_reset_physics_interpolation(RID p_item) = 0;1659virtual void canvas_item_transform_physics_interpolation(RID p_item, const Transform2D &p_transform) = 0;16601661/* CANVAS LIGHT */1662virtual RID canvas_light_create() = 0;16631664enum CanvasLightMode {1665CANVAS_LIGHT_MODE_POINT,1666CANVAS_LIGHT_MODE_DIRECTIONAL,1667};16681669virtual void canvas_light_set_mode(RID p_light, CanvasLightMode p_mode) = 0;16701671virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;1672virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;1673virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;1674virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;1675virtual void canvas_light_set_height(RID p_light, float p_height) = 0;1676virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;1677virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;1678virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;1679virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;1680virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;16811682virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;16831684virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;1685virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;1686virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;16871688enum CanvasLightBlendMode {1689CANVAS_LIGHT_BLEND_MODE_ADD,1690CANVAS_LIGHT_BLEND_MODE_SUB,1691CANVAS_LIGHT_BLEND_MODE_MIX,1692};16931694virtual void canvas_light_set_blend_mode(RID p_light, CanvasLightBlendMode p_mode) = 0;16951696enum CanvasLightShadowFilter {1697CANVAS_LIGHT_FILTER_NONE,1698CANVAS_LIGHT_FILTER_PCF5,1699CANVAS_LIGHT_FILTER_PCF13,1700CANVAS_LIGHT_FILTER_MAX1701};17021703virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;1704virtual void canvas_light_set_shadow_filter(RID p_light, CanvasLightShadowFilter p_filter) = 0;1705virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;1706virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;17071708virtual void canvas_light_set_interpolated(RID p_light, bool p_interpolated) = 0;1709virtual void canvas_light_reset_physics_interpolation(RID p_light) = 0;1710virtual void canvas_light_transform_physics_interpolation(RID p_light, const Transform2D &p_transform) = 0;17111712/* CANVAS LIGHT OCCLUDER */17131714virtual RID canvas_light_occluder_create() = 0;1715virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;1716virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;1717virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;1718virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;1719virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;1720virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;17211722virtual void canvas_light_occluder_set_interpolated(RID p_occluder, bool p_interpolated) = 0;1723virtual void canvas_light_occluder_reset_physics_interpolation(RID p_occluder) = 0;1724virtual void canvas_light_occluder_transform_physics_interpolation(RID p_occluder, const Transform2D &p_transform) = 0;17251726/* CANVAS LIGHT OCCLUDER POLYGON */17271728virtual RID canvas_occluder_polygon_create() = 0;1729virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;17301731enum CanvasOccluderPolygonCullMode {1732CANVAS_OCCLUDER_POLYGON_CULL_DISABLED,1733CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE,1734CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE,1735};17361737virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, CanvasOccluderPolygonCullMode p_mode) = 0;17381739virtual void canvas_set_shadow_texture_size(int p_size) = 0;17401741Rect2 debug_canvas_item_get_rect(RID p_item);1742virtual Rect2 _debug_canvas_item_get_rect(RID p_item) = 0;17431744/* GLOBAL SHADER UNIFORMS */17451746enum GlobalShaderParameterType {1747GLOBAL_VAR_TYPE_BOOL,1748GLOBAL_VAR_TYPE_BVEC2,1749GLOBAL_VAR_TYPE_BVEC3,1750GLOBAL_VAR_TYPE_BVEC4,1751GLOBAL_VAR_TYPE_INT,1752GLOBAL_VAR_TYPE_IVEC2,1753GLOBAL_VAR_TYPE_IVEC3,1754GLOBAL_VAR_TYPE_IVEC4,1755GLOBAL_VAR_TYPE_RECT2I,1756GLOBAL_VAR_TYPE_UINT,1757GLOBAL_VAR_TYPE_UVEC2,1758GLOBAL_VAR_TYPE_UVEC3,1759GLOBAL_VAR_TYPE_UVEC4,1760GLOBAL_VAR_TYPE_FLOAT,1761GLOBAL_VAR_TYPE_VEC2,1762GLOBAL_VAR_TYPE_VEC3,1763GLOBAL_VAR_TYPE_VEC4,1764GLOBAL_VAR_TYPE_COLOR,1765GLOBAL_VAR_TYPE_RECT2,1766GLOBAL_VAR_TYPE_MAT2,1767GLOBAL_VAR_TYPE_MAT3,1768GLOBAL_VAR_TYPE_MAT4,1769GLOBAL_VAR_TYPE_TRANSFORM_2D,1770GLOBAL_VAR_TYPE_TRANSFORM,1771GLOBAL_VAR_TYPE_SAMPLER2D,1772GLOBAL_VAR_TYPE_SAMPLER2DARRAY,1773GLOBAL_VAR_TYPE_SAMPLER3D,1774GLOBAL_VAR_TYPE_SAMPLERCUBE,1775GLOBAL_VAR_TYPE_SAMPLEREXT,1776GLOBAL_VAR_TYPE_MAX1777};17781779virtual void global_shader_parameter_add(const StringName &p_name, GlobalShaderParameterType p_type, const Variant &p_value) = 0;1780virtual void global_shader_parameter_remove(const StringName &p_name) = 0;1781virtual Vector<StringName> global_shader_parameter_get_list() const = 0;17821783virtual void global_shader_parameter_set(const StringName &p_name, const Variant &p_value) = 0;1784virtual void global_shader_parameter_set_override(const StringName &p_name, const Variant &p_value) = 0;17851786virtual Variant global_shader_parameter_get(const StringName &p_name) const = 0;1787virtual GlobalShaderParameterType global_shader_parameter_get_type(const StringName &p_name) const = 0;17881789virtual void global_shader_parameters_load_settings(bool p_load_textures) = 0;1790virtual void global_shader_parameters_clear() = 0;17911792static int global_shader_uniform_type_get_shader_datatype(GlobalShaderParameterType p_type);17931794/* FREE */17951796virtual void free_rid(RID p_rid) = 0; // Free RIDs associated with the rendering server.1797#ifndef DISABLE_DEPRECATED1798[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) {1799free_rid(p_rid);1800}1801#endif // DISABLE_DEPRECATED18021803/* INTERPOLATION */18041805virtual void set_physics_interpolation_enabled(bool p_enabled) = 0;18061807/* EVENT QUEUING */18081809virtual void request_frame_drawn_callback(const Callable &p_callable) = 0;18101811virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;1812virtual void sync() = 0;1813virtual bool has_changed() const = 0;1814virtual void init();1815virtual void finish() = 0;1816virtual void tick() = 0;1817virtual void pre_draw(bool p_will_draw) = 0;18181819/* STATUS INFORMATION */18201821enum RenderingInfo {1822RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME,1823RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME,1824RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME,1825RENDERING_INFO_TEXTURE_MEM_USED,1826RENDERING_INFO_BUFFER_MEM_USED,1827RENDERING_INFO_VIDEO_MEM_USED,1828RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS,1829RENDERING_INFO_PIPELINE_COMPILATIONS_MESH,1830RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE,1831RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW,1832RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION,1833RENDERING_INFO_MAX1834};18351836virtual uint64_t get_rendering_info(RenderingInfo p_info) = 0;1837virtual String get_video_adapter_name() const = 0;1838virtual String get_video_adapter_vendor() const = 0;1839virtual RenderingDevice::DeviceType get_video_adapter_type() const = 0;1840virtual String get_video_adapter_api_version() const = 0;18411842struct FrameProfileArea {1843String name;1844double gpu_msec;1845double cpu_msec;1846};18471848virtual void set_frame_profiling_enabled(bool p_enable) = 0;1849virtual Vector<FrameProfileArea> get_frame_profile() = 0;1850virtual uint64_t get_frame_profile_frame() = 0;18511852virtual double get_frame_setup_time_cpu() const = 0;18531854virtual void gi_set_use_half_resolution(bool p_enable) = 0;18551856/* TESTING */18571858virtual RID get_test_cube() = 0;18591860virtual RID get_test_texture();1861virtual RID get_white_texture();18621863virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;18641865virtual RID make_sphere_mesh(int p_lats, int p_lons, real_t p_radius);18661867virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);1868virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);18691870enum SplashStretchMode {1871SPLASH_STRETCH_MODE_DISABLED,1872SPLASH_STRETCH_MODE_KEEP,1873SPLASH_STRETCH_MODE_KEEP_WIDTH,1874SPLASH_STRETCH_MODE_KEEP_HEIGHT,1875SPLASH_STRETCH_MODE_COVER,1876SPLASH_STRETCH_MODE_IGNORE,1877};18781879virtual void set_boot_image_with_stretch(const Ref<Image> &p_image, const Color &p_color, SplashStretchMode p_stretch_mode, bool p_use_filter = true) = 0;1880static Rect2 get_splash_stretched_screen_rect(const Size2 &p_image_size, const Size2 &p_window_size, SplashStretchMode p_stretch_mode); // Helper for splash screen1881#ifndef DISABLE_DEPRECATED1882void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true); // Superseded, but left to preserve compat.1883#endif1884_ALWAYS_INLINE_ static SplashStretchMode map_scaling_option_to_stretch_mode(bool p_scale) {1885return p_scale ? SplashStretchMode::SPLASH_STRETCH_MODE_KEEP : SplashStretchMode::SPLASH_STRETCH_MODE_DISABLED;1886}1887virtual Color get_default_clear_color() = 0;1888virtual void set_default_clear_color(const Color &p_color) = 0;18891890#ifndef DISABLE_DEPRECATED1891// Never actually used, should be removed when we can break compatibility.1892enum Features {1893FEATURE_SHADERS,1894FEATURE_MULTITHREADED,1895};1896virtual bool has_feature(Features p_feature) const = 0;1897#endif1898virtual bool has_os_feature(const String &p_feature) const = 0;18991900virtual void set_debug_generate_wireframes(bool p_generate) = 0;19011902virtual void call_set_vsync_mode(DisplayServer::VSyncMode p_mode, DisplayServer::WindowID p_window) = 0;19031904virtual bool is_low_end() const = 0;19051906virtual void set_print_gpu_profile(bool p_enable) = 0;19071908virtual Size2i get_maximum_viewport_size() const = 0;19091910RenderingDevice *get_rendering_device() const;1911RenderingDevice *create_local_rendering_device() const;19121913bool is_render_loop_enabled() const;1914void set_render_loop_enabled(bool p_enabled);19151916virtual bool is_on_render_thread() = 0;1917virtual void call_on_render_thread(const Callable &p_callable) = 0;19181919String get_current_rendering_driver_name() const;1920String get_current_rendering_method() const;19211922#ifdef TOOLS_ENABLED1923virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const override;1924#endif19251926RenderingServer();1927virtual ~RenderingServer();19281929#ifdef TOOLS_ENABLED1930typedef void (*SurfaceUpgradeCallback)();1931void set_surface_upgrade_callback(SurfaceUpgradeCallback p_callback);1932void set_warn_on_surface_upgrade(bool p_warn);1933#endif19341935#ifndef DISABLE_DEPRECATED1936void fix_surface_compatibility(SurfaceData &p_surface, const String &p_path = "");1937#endif19381939private:1940// Binder helpers1941RID _texture_2d_layered_create(const TypedArray<Image> &p_layers, TextureLayeredType p_layered_type);1942RID _texture_3d_create(Image::Format p_format, int p_width, int p_height, int p_depth, bool p_mipmaps, const TypedArray<Image> &p_data);1943void _texture_3d_update(RID p_texture, const TypedArray<Image> &p_data);1944TypedArray<Image> _texture_3d_get(RID p_texture) const;1945TypedArray<Dictionary> _shader_get_shader_parameter_list(RID p_shader) const;1946RID _mesh_create_from_surfaces(const TypedArray<Dictionary> &p_surfaces, int p_blend_shape_count);1947void _mesh_add_surface(RID p_mesh, const Dictionary &p_surface);1948Dictionary _mesh_get_surface(RID p_mesh, int p_idx);1949TypedArray<Dictionary> _instance_geometry_get_shader_parameter_list(RID p_instance) const;1950TypedArray<Dictionary> _canvas_item_get_instance_shader_parameter_list(RID p_item) const;1951TypedArray<Image> _bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size);1952void _particles_set_trail_bind_poses(RID p_particles, const TypedArray<Transform3D> &p_bind_poses);1953#ifdef TOOLS_ENABLED1954SurfaceUpgradeCallback surface_upgrade_callback = nullptr;1955bool warn_on_surface_upgrade = true;1956#endif1957};19581959// Make variant understand the enums.1960VARIANT_ENUM_CAST(RenderingServer::TextureType);1961VARIANT_ENUM_CAST(RenderingServer::TextureLayeredType);1962VARIANT_ENUM_CAST(RenderingServer::CubeMapLayer);1963VARIANT_ENUM_CAST(RenderingServer::TextureDrawableFormat);1964VARIANT_ENUM_CAST(RenderingServer::PipelineSource);1965VARIANT_ENUM_CAST(RenderingServer::ShaderMode);1966VARIANT_ENUM_CAST(RenderingServer::ArrayType);1967VARIANT_BITFIELD_CAST(RenderingServer::ArrayFormat);1968VARIANT_ENUM_CAST(RenderingServer::ArrayCustomFormat);1969VARIANT_ENUM_CAST(RenderingServer::PrimitiveType);1970VARIANT_ENUM_CAST(RenderingServer::BlendShapeMode);1971VARIANT_ENUM_CAST(RenderingServer::MultimeshTransformFormat);1972VARIANT_ENUM_CAST(RenderingServer::MultimeshPhysicsInterpolationQuality);1973VARIANT_ENUM_CAST(RenderingServer::LightType);1974VARIANT_ENUM_CAST(RenderingServer::LightParam);1975VARIANT_ENUM_CAST(RenderingServer::LightBakeMode);1976VARIANT_ENUM_CAST(RenderingServer::LightOmniShadowMode);1977VARIANT_ENUM_CAST(RenderingServer::LightDirectionalShadowMode);1978VARIANT_ENUM_CAST(RenderingServer::LightDirectionalSkyMode);1979VARIANT_ENUM_CAST(RenderingServer::LightProjectorFilter);1980VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeUpdateMode);1981VARIANT_ENUM_CAST(RenderingServer::ReflectionProbeAmbientMode);1982VARIANT_ENUM_CAST(RenderingServer::VoxelGIQuality);1983VARIANT_ENUM_CAST(RenderingServer::DecalTexture);1984VARIANT_ENUM_CAST(RenderingServer::DecalFilter);1985VARIANT_ENUM_CAST(RenderingServer::ParticlesMode);1986VARIANT_ENUM_CAST(RenderingServer::ParticlesTransformAlign);1987VARIANT_ENUM_CAST(RenderingServer::ParticlesDrawOrder);1988VARIANT_ENUM_CAST(RenderingServer::ParticlesEmitFlags);1989VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionType);1990VARIANT_ENUM_CAST(RenderingServer::ParticlesCollisionHeightfieldResolution);1991VARIANT_ENUM_CAST(RenderingServer::FogVolumeShape);1992VARIANT_ENUM_CAST(RenderingServer::ViewportScaling3DMode);1993VARIANT_ENUM_CAST(RenderingServer::ViewportUpdateMode);1994VARIANT_ENUM_CAST(RenderingServer::ViewportClearMode);1995VARIANT_ENUM_CAST(RenderingServer::ViewportEnvironmentMode);1996VARIANT_ENUM_CAST(RenderingServer::ViewportMSAA);1997VARIANT_ENUM_CAST(RenderingServer::ViewportAnisotropicFiltering);1998VARIANT_ENUM_CAST(RenderingServer::ViewportScreenSpaceAA);1999VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfo);2000VARIANT_ENUM_CAST(RenderingServer::ViewportRenderInfoType);2001VARIANT_ENUM_CAST(RenderingServer::ViewportDebugDraw);2002VARIANT_ENUM_CAST(RenderingServer::ViewportOcclusionCullingBuildQuality);2003VARIANT_ENUM_CAST(RenderingServer::ViewportSDFOversize);2004VARIANT_ENUM_CAST(RenderingServer::ViewportSDFScale);2005VARIANT_ENUM_CAST(RenderingServer::ViewportVRSMode);2006VARIANT_ENUM_CAST(RenderingServer::ViewportVRSUpdateMode);2007VARIANT_ENUM_CAST(RenderingServer::SkyMode);2008VARIANT_ENUM_CAST(RenderingServer::CompositorEffectCallbackType);2009VARIANT_ENUM_CAST(RenderingServer::CompositorEffectFlags);2010VARIANT_ENUM_CAST(RenderingServer::EnvironmentBG);2011VARIANT_ENUM_CAST(RenderingServer::EnvironmentAmbientSource);2012VARIANT_ENUM_CAST(RenderingServer::EnvironmentReflectionSource);2013VARIANT_ENUM_CAST(RenderingServer::EnvironmentGlowBlendMode);2014VARIANT_ENUM_CAST(RenderingServer::EnvironmentFogMode);2015VARIANT_ENUM_CAST(RenderingServer::EnvironmentToneMapper);2016VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSRRoughnessQuality);2017VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSAOQuality);2018VARIANT_ENUM_CAST(RenderingServer::EnvironmentSSILQuality);2019VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToConverge);2020VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIRayCount);2021VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIFramesToUpdateLight);2022VARIANT_ENUM_CAST(RenderingServer::EnvironmentSDFGIYScale);2023VARIANT_ENUM_CAST(RenderingServer::SubSurfaceScatteringQuality);2024VARIANT_ENUM_CAST(RenderingServer::DOFBlurQuality);2025VARIANT_ENUM_CAST(RenderingServer::DOFBokehShape);2026VARIANT_ENUM_CAST(RenderingServer::ShadowQuality);2027VARIANT_ENUM_CAST(RenderingServer::InstanceType);2028VARIANT_ENUM_CAST(RenderingServer::InstanceFlags);2029VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);2030VARIANT_ENUM_CAST(RenderingServer::VisibilityRangeFadeMode);2031VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);2032VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);2033VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);2034VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);2035VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);2036VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);2037VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);2038VARIANT_ENUM_CAST(RenderingServer::CanvasOccluderPolygonCullMode);2039VARIANT_ENUM_CAST(RenderingServer::GlobalShaderParameterType);2040VARIANT_ENUM_CAST(RenderingServer::RenderingInfo);2041VARIANT_ENUM_CAST(RenderingServer::SplashStretchMode);2042VARIANT_ENUM_CAST(RenderingServer::CanvasTextureChannel);2043VARIANT_ENUM_CAST(RenderingServer::BakeChannels);20442045#ifndef DISABLE_DEPRECATED2046VARIANT_ENUM_CAST(RenderingServer::Features);2047#endif20482049// Alias to make it easier to use.2050#define RS RenderingServer205120522053