git-subtree-dir: engine git-subtree-mainline:b74841629egit-subtree-split:a8e37fc010
1163 lines
70 KiB
C++
1163 lines
70 KiB
C++
/**************************************************************************/
|
|
/* rendering_server.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "core/io/image.h"
|
|
#include "core/templates/rid.h"
|
|
#include "core/variant/typed_array.h"
|
|
#include "core/variant/variant.h"
|
|
#include "servers/display/display_server_enums.h"
|
|
#include "servers/rendering/rendering_device_enums.h"
|
|
#include "servers/rendering/rendering_server_enums.h"
|
|
#include "servers/rendering/rendering_server_types.h"
|
|
|
|
namespace Geometry3D {
|
|
struct MeshData;
|
|
}
|
|
|
|
// Helper macros for code outside of the rendering server, but that is
|
|
// called by the rendering server.
|
|
#ifdef DEBUG_ENABLED
|
|
#define ERR_NOT_ON_RENDER_THREAD \
|
|
RenderingServer *rendering_server = RenderingServer::get_singleton(); \
|
|
ERR_FAIL_NULL(rendering_server); \
|
|
ERR_FAIL_COND(!rendering_server->is_on_render_thread());
|
|
#define ERR_NOT_ON_RENDER_THREAD_V(m_ret) \
|
|
RenderingServer *rendering_server = RenderingServer::get_singleton(); \
|
|
ERR_FAIL_NULL_V(rendering_server, m_ret); \
|
|
ERR_FAIL_COND_V(!rendering_server->is_on_render_thread(), m_ret);
|
|
#else
|
|
#define ERR_NOT_ON_RENDER_THREAD
|
|
#define ERR_NOT_ON_RENDER_THREAD_V(m_ret)
|
|
#endif
|
|
|
|
class RenderingDevice;
|
|
|
|
class RenderingServer : public Object {
|
|
GDCLASS(RenderingServer, Object);
|
|
|
|
static RenderingServer *singleton;
|
|
|
|
int mm_policy = 0;
|
|
bool render_loop_enabled = true;
|
|
|
|
Array _get_array_from_surface(uint64_t p_format, Vector<uint8_t> p_vertex_data, Vector<uint8_t> p_attrib_data, Vector<uint8_t> p_skin_data, int p_vertex_len, Vector<uint8_t> p_index_data, int p_index_len, const AABB &p_aabb, const Vector4 &p_uv_scale) const;
|
|
|
|
const Vector2 SMALL_VEC2 = Vector2(CMP_EPSILON, CMP_EPSILON);
|
|
const Vector3 SMALL_VEC3 = Vector3(CMP_EPSILON, CMP_EPSILON, CMP_EPSILON);
|
|
|
|
virtual TypedArray<StringName> _global_shader_parameter_get_list() const;
|
|
|
|
protected:
|
|
RID _make_test_cube();
|
|
void _free_internal_rids();
|
|
RID test_texture;
|
|
RID white_texture;
|
|
RID test_material;
|
|
|
|
Error _surface_set_data(Array p_arrays, uint64_t p_format, uint32_t *p_offsets, uint32_t p_vertex_stride, uint32_t p_normal_stride, uint32_t p_attrib_stride, uint32_t p_skin_stride, Vector<uint8_t> &r_vertex_array, Vector<uint8_t> &r_attrib_array, Vector<uint8_t> &r_skin_array, int p_vertex_array_len, Vector<uint8_t> &r_index_array, int p_index_array_len, AABB &r_aabb, Vector<AABB> &r_bone_aabb, Vector4 &r_uv_scale);
|
|
|
|
static RenderingServer *(*create_func)();
|
|
static void _bind_methods();
|
|
|
|
#ifndef DISABLE_DEPRECATED
|
|
void _environment_set_fog_bind_compat_84792(RID p_env, bool p_enable, const Color &p_light_color, float p_light_energy, float p_sun_scatter, float p_density, float p_height, float p_height_density, float p_aerial_perspective, float p_sky_affect);
|
|
void _canvas_item_add_multiline_bind_compat_84523(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0);
|
|
void _canvas_item_add_rect_bind_compat_84523(RID p_item, const Rect2 &p_rect, const Color &p_color);
|
|
void _canvas_item_add_circle_bind_compat_84523(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color);
|
|
void _instance_set_interpolated_bind_compat_104269(RID p_instance, bool p_interpolated);
|
|
void _instance_reset_physics_interpolation_bind_compat_104269(RID p_instance);
|
|
void _viewport_set_size_compat_115799(RID p_viewport, int p_width, int p_height);
|
|
|
|
static void _bind_compatibility_methods();
|
|
#endif
|
|
|
|
public:
|
|
static RenderingServer *get_singleton();
|
|
static RenderingServer *create();
|
|
|
|
/* TEXTURE API */
|
|
|
|
virtual RID texture_2d_create(const Ref<Image> &p_image) = 0;
|
|
virtual RID texture_2d_layered_create(const Vector<Ref<Image>> &p_layers, RSE::TextureLayeredType p_layered_type) = 0;
|
|
virtual RID texture_3d_create(Image::Format, int p_width, int p_height, int p_depth, bool p_mipmaps, const Vector<Ref<Image>> &p_data) = 0; //all slices, then all the mipmaps, must be coherent
|
|
virtual RID texture_external_create(int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;
|
|
virtual RID texture_proxy_create(RID p_base) = 0;
|
|
virtual RID texture_drawable_create(int p_width, int p_height, RSE::TextureDrawableFormat p_format, const Color &p_color = Color(1, 1, 1, 1), bool p_with_mipmaps = false) = 0;
|
|
|
|
virtual RID texture_create_from_native_handle(RSE::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, RSE::TextureLayeredType p_layered_type = RSE::TEXTURE_LAYERED_2D_ARRAY) = 0;
|
|
|
|
virtual void texture_2d_update(RID p_texture, const Ref<Image> &p_image, int p_layer = 0) = 0;
|
|
virtual void texture_3d_update(RID p_texture, const Vector<Ref<Image>> &p_data) = 0;
|
|
virtual void texture_external_update(RID p_texture, int p_width, int p_height, uint64_t p_external_buffer = 0) = 0;
|
|
virtual void texture_proxy_update(RID p_texture, RID p_proxy_to) = 0;
|
|
|
|
virtual void texture_drawable_blit_rect(const TypedArray<RID> &p_textures, const Rect2i &p_rect, RID p_material, const Color &p_modulate, const TypedArray<RID> &p_source_textures, int p_to_mipmap = 0) = 0;
|
|
|
|
// These two APIs can be used together or in combination with the others.
|
|
virtual RID texture_2d_placeholder_create() = 0;
|
|
virtual RID texture_2d_layered_placeholder_create(RSE::TextureLayeredType p_layered_type) = 0;
|
|
virtual RID texture_3d_placeholder_create() = 0;
|
|
|
|
virtual Ref<Image> texture_2d_get(RID p_texture) const = 0;
|
|
virtual Ref<Image> texture_2d_layer_get(RID p_texture, int p_layer) const = 0;
|
|
virtual Vector<Ref<Image>> texture_3d_get(RID p_texture) const = 0;
|
|
|
|
virtual void texture_replace(RID p_texture, RID p_by_texture) = 0;
|
|
virtual void texture_set_size_override(RID p_texture, int p_width, int p_height) = 0;
|
|
|
|
virtual void texture_set_path(RID p_texture, const String &p_path) = 0;
|
|
virtual String texture_get_path(RID p_texture) const = 0;
|
|
|
|
virtual void texture_drawable_generate_mipmaps(RID p_texture) = 0; // Update mipmaps if modified
|
|
virtual RID texture_drawable_get_default_material() const = 0; // To use with simplified functions in DrawableTexture2D
|
|
|
|
virtual Image::Format texture_get_format(RID p_texture) const = 0;
|
|
|
|
virtual void texture_set_detect_3d_callback(RID p_texture, RenderingServerTypes::TextureDetectCallback p_callback, void *p_userdata) = 0;
|
|
virtual void texture_set_detect_normal_callback(RID p_texture, RenderingServerTypes::TextureDetectCallback p_callback, void *p_userdata) = 0;
|
|
virtual void texture_set_detect_roughness_callback(RID p_texture, RenderingServerTypes::TextureDetectRoughnessCallback p_callback, void *p_userdata) = 0;
|
|
|
|
virtual void texture_debug_usage(List<RenderingServerTypes::TextureInfo> *r_info) = 0;
|
|
Array _texture_debug_usage_bind();
|
|
|
|
virtual void texture_set_force_redraw_if_visible(RID p_texture, bool p_enable) = 0;
|
|
|
|
virtual RID texture_rd_create(const RID &p_rd_texture, const RSE::TextureLayeredType p_layer_type = RSE::TEXTURE_LAYERED_2D_ARRAY) = 0;
|
|
virtual RID texture_get_rd_texture(RID p_texture, bool p_srgb = false) const = 0;
|
|
virtual uint64_t texture_get_native_handle(RID p_texture, bool p_srgb = false) const = 0;
|
|
|
|
/* SHADER API */
|
|
|
|
virtual RID shader_create() = 0;
|
|
virtual RID shader_create_from_code(const String &p_code, const String &p_path_hint = String()) = 0;
|
|
|
|
virtual void shader_set_code(RID p_shader, const String &p_code) = 0;
|
|
virtual void shader_set_path_hint(RID p_shader, const String &p_path) = 0;
|
|
virtual String shader_get_code(RID p_shader) const = 0;
|
|
virtual void get_shader_parameter_list(RID p_shader, List<PropertyInfo> *p_param_list) const = 0;
|
|
virtual Variant shader_get_parameter_default(RID p_shader, const StringName &p_param) const = 0;
|
|
|
|
virtual void shader_set_default_texture_parameter(RID p_shader, const StringName &p_name, RID p_texture, int p_index = 0) = 0;
|
|
virtual RID shader_get_default_texture_parameter(RID p_shader, const StringName &p_name, int p_index = 0) const = 0;
|
|
|
|
virtual RenderingServerTypes::ShaderNativeSourceCode shader_get_native_source_code(RID p_shader) const = 0;
|
|
|
|
/* COMMON MATERIAL API */
|
|
|
|
virtual RID material_create() = 0;
|
|
virtual RID material_create_from_shader(RID p_next_pass, int p_render_priority, RID p_shader) = 0;
|
|
|
|
virtual void material_set_shader(RID p_shader_material, RID p_shader) = 0;
|
|
|
|
virtual void material_set_param(RID p_material, const StringName &p_param, const Variant &p_value) = 0;
|
|
virtual Variant material_get_param(RID p_material, const StringName &p_param) const = 0;
|
|
|
|
virtual void material_set_render_priority(RID p_material, int priority) = 0;
|
|
|
|
virtual void material_set_next_pass(RID p_material, RID p_next_material) = 0;
|
|
|
|
virtual void material_set_use_debanding(bool p_enable) = 0;
|
|
|
|
/* MESH API */
|
|
|
|
virtual RID mesh_create_from_surfaces(const Vector<RenderingServerTypes::SurfaceData> &p_surfaces, int p_blend_shape_count = 0) = 0;
|
|
virtual RID mesh_create() = 0;
|
|
|
|
virtual void mesh_set_blend_shape_count(RID p_mesh, int p_blend_shape_count) = 0;
|
|
|
|
virtual uint32_t mesh_surface_get_format_offset(BitField<RSE::ArrayFormat> p_format, int p_vertex_len, int p_array_index) const;
|
|
virtual uint32_t mesh_surface_get_format_vertex_stride(BitField<RSE::ArrayFormat> p_format, int p_vertex_len) const;
|
|
virtual uint32_t mesh_surface_get_format_normal_tangent_stride(BitField<RSE::ArrayFormat> p_format, int p_vertex_len) const;
|
|
virtual uint32_t mesh_surface_get_format_attribute_stride(BitField<RSE::ArrayFormat> p_format, int p_vertex_len) const;
|
|
virtual uint32_t mesh_surface_get_format_skin_stride(BitField<RSE::ArrayFormat> p_format, int p_vertex_len) const;
|
|
virtual uint32_t mesh_surface_get_format_index_stride(BitField<RSE::ArrayFormat> p_format, int p_vertex_len) const;
|
|
|
|
/// Returns stride
|
|
virtual void mesh_surface_make_offsets_from_format(uint64_t p_format, int p_vertex_len, int p_index_len, uint32_t *r_offsets, uint32_t &r_vertex_element_size, uint32_t &r_normal_element_size, uint32_t &r_attrib_element_size, uint32_t &r_skin_element_size) const;
|
|
virtual Error mesh_create_surface_data_from_arrays(RenderingServerTypes::SurfaceData *r_surface_data, RSE::PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), uint64_t p_compress_format = 0);
|
|
Array mesh_create_arrays_from_surface_data(const RenderingServerTypes::SurfaceData &p_data) const;
|
|
Array mesh_surface_get_arrays(RID p_mesh, int p_surface) const;
|
|
TypedArray<Array> mesh_surface_get_blend_shape_arrays(RID p_mesh, int p_surface) const;
|
|
Dictionary mesh_surface_get_lods(RID p_mesh, int p_surface) const;
|
|
|
|
virtual void mesh_add_surface_from_arrays(RID p_mesh, RSE::PrimitiveType p_primitive, const Array &p_arrays, const Array &p_blend_shapes = Array(), const Dictionary &p_lods = Dictionary(), BitField<RSE::ArrayFormat> p_compress_format = 0);
|
|
virtual void mesh_add_surface(RID p_mesh, const RenderingServerTypes::SurfaceData &p_surface) = 0;
|
|
|
|
virtual int mesh_get_blend_shape_count(RID p_mesh) const = 0;
|
|
|
|
virtual void mesh_set_blend_shape_mode(RID p_mesh, RSE::BlendShapeMode p_mode) = 0;
|
|
virtual RSE::BlendShapeMode mesh_get_blend_shape_mode(RID p_mesh) const = 0;
|
|
|
|
virtual void mesh_surface_update_vertex_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
|
|
virtual void mesh_surface_update_attribute_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
|
|
virtual void mesh_surface_update_skin_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
|
|
virtual void mesh_surface_update_index_region(RID p_mesh, int p_surface, int p_offset, const Vector<uint8_t> &p_data) = 0;
|
|
|
|
virtual void mesh_surface_set_material(RID p_mesh, int p_surface, RID p_material) = 0;
|
|
virtual RID mesh_surface_get_material(RID p_mesh, int p_surface) const = 0;
|
|
|
|
virtual RenderingServerTypes::SurfaceData mesh_get_surface(RID p_mesh, int p_surface) const = 0;
|
|
|
|
virtual int mesh_get_surface_count(RID p_mesh) const = 0;
|
|
|
|
virtual void mesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
|
|
virtual AABB mesh_get_custom_aabb(RID p_mesh) const = 0;
|
|
|
|
virtual void mesh_set_path(RID p_mesh, const String &p_path) = 0;
|
|
virtual String mesh_get_path(RID p_mesh) const = 0;
|
|
|
|
virtual void mesh_set_shadow_mesh(RID p_mesh, RID p_shadow_mesh) = 0;
|
|
|
|
virtual void mesh_surface_remove(RID p_mesh, int p_surface) = 0;
|
|
virtual void mesh_clear(RID p_mesh) = 0;
|
|
|
|
virtual void mesh_debug_usage(List<RenderingServerTypes::MeshInfo> *r_info) = 0;
|
|
|
|
/* MULTIMESH API */
|
|
|
|
virtual RID multimesh_create() = 0;
|
|
|
|
protected:
|
|
#ifndef DISABLE_DEPRECATED
|
|
void _multimesh_allocate_data_bind_compat_99455(RID p_multimesh, int p_instances, RSE::MultimeshTransformFormat p_transform_format, bool p_use_colors, bool p_use_custom_data);
|
|
#endif
|
|
public:
|
|
virtual void multimesh_allocate_data(RID p_multimesh, int p_instances, RSE::MultimeshTransformFormat p_transform_format, bool p_use_colors = false, bool p_use_custom_data = false, bool p_use_indirect = false) = 0;
|
|
virtual int multimesh_get_instance_count(RID p_multimesh) const = 0;
|
|
|
|
virtual void multimesh_set_mesh(RID p_multimesh, RID p_mesh) = 0;
|
|
virtual void multimesh_instance_set_transform(RID p_multimesh, int p_index, const Transform3D &p_transform) = 0;
|
|
virtual void multimesh_instance_set_transform_2d(RID p_multimesh, int p_index, const Transform2D &p_transform) = 0;
|
|
virtual void multimesh_instance_set_color(RID p_multimesh, int p_index, const Color &p_color) = 0;
|
|
virtual void multimesh_instance_set_custom_data(RID p_multimesh, int p_index, const Color &p_color) = 0;
|
|
|
|
virtual RID multimesh_get_mesh(RID p_multimesh) const = 0;
|
|
virtual AABB multimesh_get_aabb(RID p_multimesh) const = 0;
|
|
|
|
virtual void multimesh_set_custom_aabb(RID p_mesh, const AABB &p_aabb) = 0;
|
|
virtual AABB multimesh_get_custom_aabb(RID p_mesh) const = 0;
|
|
|
|
virtual Transform3D multimesh_instance_get_transform(RID p_multimesh, int p_index) const = 0;
|
|
virtual Transform2D multimesh_instance_get_transform_2d(RID p_multimesh, int p_index) const = 0;
|
|
virtual Color multimesh_instance_get_color(RID p_multimesh, int p_index) const = 0;
|
|
virtual Color multimesh_instance_get_custom_data(RID p_multimesh, int p_index) const = 0;
|
|
|
|
virtual void multimesh_set_buffer(RID p_multimesh, const Vector<float> &p_buffer) = 0;
|
|
virtual RID multimesh_get_command_buffer_rd_rid(RID p_multimesh) const = 0;
|
|
virtual RID multimesh_get_buffer_rd_rid(RID p_multimesh) const = 0;
|
|
virtual Vector<float> multimesh_get_buffer(RID p_multimesh) const = 0;
|
|
|
|
// Interpolation.
|
|
virtual void multimesh_set_buffer_interpolated(RID p_multimesh, const Vector<float> &p_buffer_curr, const Vector<float> &p_buffer_prev) = 0;
|
|
virtual void multimesh_set_physics_interpolated(RID p_multimesh, bool p_interpolated) = 0;
|
|
virtual void multimesh_set_physics_interpolation_quality(RID p_multimesh, RSE::MultimeshPhysicsInterpolationQuality p_quality) = 0;
|
|
virtual void multimesh_instance_reset_physics_interpolation(RID p_multimesh, int p_index) = 0;
|
|
virtual void multimesh_instances_reset_physics_interpolation(RID p_multimesh) = 0;
|
|
|
|
virtual void multimesh_set_visible_instances(RID p_multimesh, int p_visible) = 0;
|
|
virtual int multimesh_get_visible_instances(RID p_multimesh) const = 0;
|
|
|
|
/* SKELETON API */
|
|
|
|
virtual RID skeleton_create() = 0;
|
|
virtual void skeleton_allocate_data(RID p_skeleton, int p_bones, bool p_2d_skeleton = false) = 0;
|
|
virtual int skeleton_get_bone_count(RID p_skeleton) const = 0;
|
|
virtual void skeleton_bone_set_transform(RID p_skeleton, int p_bone, const Transform3D &p_transform) = 0;
|
|
virtual Transform3D skeleton_bone_get_transform(RID p_skeleton, int p_bone) const = 0;
|
|
virtual void skeleton_bone_set_transform_2d(RID p_skeleton, int p_bone, const Transform2D &p_transform) = 0;
|
|
virtual Transform2D skeleton_bone_get_transform_2d(RID p_skeleton, int p_bone) const = 0;
|
|
virtual void skeleton_set_base_transform_2d(RID p_skeleton, const Transform2D &p_base_transform) = 0;
|
|
|
|
/* LIGHT API */
|
|
|
|
virtual RID directional_light_create() = 0;
|
|
virtual RID omni_light_create() = 0;
|
|
virtual RID spot_light_create() = 0;
|
|
|
|
virtual void light_set_color(RID p_light, const Color &p_color) = 0;
|
|
virtual void light_set_param(RID p_light, RSE::LightParam p_param, float p_value) = 0;
|
|
virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
|
|
virtual void light_set_projector(RID p_light, RID p_texture) = 0;
|
|
virtual void light_set_negative(RID p_light, bool p_enable) = 0;
|
|
virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
|
|
virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;
|
|
virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
|
|
virtual void light_set_shadow_caster_mask(RID p_light, uint32_t p_caster_mask) = 0;
|
|
|
|
virtual void light_set_bake_mode(RID p_light, RSE::LightBakeMode p_bake_mode) = 0;
|
|
virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
|
|
|
|
// Omni light
|
|
|
|
virtual void light_omni_set_shadow_mode(RID p_light, RSE::LightOmniShadowMode p_mode) = 0;
|
|
|
|
// Directional light
|
|
|
|
virtual void light_directional_set_shadow_mode(RID p_light, RSE::LightDirectionalShadowMode p_mode) = 0;
|
|
virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
|
|
virtual void light_directional_set_sky_mode(RID p_light, RSE::LightDirectionalSkyMode p_mode) = 0;
|
|
|
|
// Shadow atlas
|
|
|
|
virtual RID shadow_atlas_create() = 0;
|
|
virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;
|
|
virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;
|
|
|
|
virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;
|
|
|
|
virtual void positional_soft_shadow_filter_set_quality(RSE::ShadowQuality p_quality) = 0;
|
|
virtual void directional_soft_shadow_filter_set_quality(RSE::ShadowQuality p_quality) = 0;
|
|
|
|
virtual void light_projectors_set_filter(RSE::LightProjectorFilter p_filter) = 0;
|
|
|
|
/* REFLECTION PROBE API */
|
|
|
|
virtual RID reflection_probe_create() = 0;
|
|
|
|
virtual void reflection_probe_set_update_mode(RID p_probe, RSE::ReflectionProbeUpdateMode p_mode) = 0;
|
|
virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
|
|
virtual void reflection_probe_set_blend_distance(RID p_probe, float p_blend_distance) = 0;
|
|
|
|
virtual void reflection_probe_set_ambient_mode(RID p_probe, RSE::ReflectionProbeAmbientMode p_mode) = 0;
|
|
virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
|
|
virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
|
|
virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
|
|
virtual void reflection_probe_set_size(RID p_probe, const Vector3 &p_size) = 0;
|
|
virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
|
|
virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
|
|
virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
|
|
virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
|
|
virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
|
|
virtual void reflection_probe_set_reflection_mask(RID p_probe, uint32_t p_layers) = 0;
|
|
virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
|
|
virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_pixels) = 0;
|
|
|
|
/* DECAL API */
|
|
|
|
virtual RID decal_create() = 0;
|
|
virtual void decal_set_size(RID p_decal, const Vector3 &p_size) = 0;
|
|
virtual void decal_set_texture(RID p_decal, RSE::DecalTexture p_type, RID p_texture) = 0;
|
|
virtual void decal_set_emission_energy(RID p_decal, float p_energy) = 0;
|
|
virtual void decal_set_albedo_mix(RID p_decal, float p_mix) = 0;
|
|
virtual void decal_set_modulate(RID p_decal, const Color &p_modulate) = 0;
|
|
virtual void decal_set_cull_mask(RID p_decal, uint32_t p_layers) = 0;
|
|
virtual void decal_set_distance_fade(RID p_decal, bool p_enabled, float p_begin, float p_length) = 0;
|
|
virtual void decal_set_fade(RID p_decal, float p_above, float p_below) = 0;
|
|
virtual void decal_set_normal_fade(RID p_decal, float p_fade) = 0;
|
|
|
|
virtual void decals_set_filter(RSE::DecalFilter p_quality) = 0;
|
|
|
|
/* VOXEL GI API */
|
|
|
|
virtual RID voxel_gi_create() = 0;
|
|
|
|
virtual void voxel_gi_allocate_data(RID p_voxel_gi, const Transform3D &p_to_cell_xform, const AABB &p_aabb, const Vector3i &p_octree_size, const Vector<uint8_t> &p_octree_cells, const Vector<uint8_t> &p_data_cells, const Vector<uint8_t> &p_distance_field, const Vector<int> &p_level_counts) = 0;
|
|
|
|
virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;
|
|
virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;
|
|
virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;
|
|
virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;
|
|
virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;
|
|
virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;
|
|
virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;
|
|
|
|
virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;
|
|
virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;
|
|
virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;
|
|
virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;
|
|
virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;
|
|
virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;
|
|
virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;
|
|
virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;
|
|
|
|
virtual void voxel_gi_set_quality(RSE::VoxelGIQuality) = 0;
|
|
|
|
virtual void sdfgi_reset() = 0;
|
|
|
|
/* LIGHTMAP API */
|
|
|
|
virtual RID lightmap_create() = 0;
|
|
|
|
virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
|
|
virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
|
|
virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
|
|
virtual void lightmap_set_probe_capture_data(RID p_lightmap, const PackedVector3Array &p_points, const PackedColorArray &p_point_sh, const PackedInt32Array &p_tetrahedra, const PackedInt32Array &p_bsp_tree) = 0;
|
|
virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;
|
|
virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
|
|
virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
|
|
virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
|
|
virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
|
|
|
|
virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
|
|
virtual void lightmaps_set_bicubic_filter(bool p_enable) = 0;
|
|
|
|
virtual void lightmap_set_shadowmask_textures(RID p_lightmap, RID p_shadow) = 0;
|
|
virtual RSE::ShadowmaskMode lightmap_get_shadowmask_mode(RID p_lightmap) = 0;
|
|
virtual void lightmap_set_shadowmask_mode(RID p_lightmap, RSE::ShadowmaskMode p_mode) = 0;
|
|
|
|
/* PARTICLES API */
|
|
|
|
virtual RID particles_create() = 0;
|
|
virtual void particles_set_mode(RID p_particles, RSE::ParticlesMode p_mode) = 0;
|
|
|
|
virtual void particles_set_emitting(RID p_particles, bool p_enable) = 0;
|
|
virtual bool particles_get_emitting(RID p_particles) = 0;
|
|
virtual void particles_set_amount(RID p_particles, int p_amount) = 0;
|
|
virtual void particles_set_amount_ratio(RID p_particles, float p_amount_ratio) = 0;
|
|
virtual void particles_set_lifetime(RID p_particles, double p_lifetime) = 0;
|
|
virtual void particles_set_one_shot(RID p_particles, bool p_one_shot) = 0;
|
|
virtual void particles_set_pre_process_time(RID p_particles, double p_time) = 0;
|
|
virtual void particles_request_process_time(RID p_particles, real_t p_request_process_time) = 0;
|
|
virtual void particles_set_explosiveness_ratio(RID p_particles, float p_ratio) = 0;
|
|
virtual void particles_set_randomness_ratio(RID p_particles, float p_ratio) = 0;
|
|
virtual void particles_set_custom_aabb(RID p_particles, const AABB &p_aabb) = 0;
|
|
virtual void particles_set_speed_scale(RID p_particles, double p_scale) = 0;
|
|
virtual void particles_set_use_local_coordinates(RID p_particles, bool p_enable) = 0;
|
|
virtual void particles_set_process_material(RID p_particles, RID p_material) = 0;
|
|
virtual void particles_set_fixed_fps(RID p_particles, int p_fps) = 0;
|
|
virtual void particles_set_interpolate(RID p_particles, bool p_enable) = 0;
|
|
virtual void particles_set_fractional_delta(RID p_particles, bool p_enable) = 0;
|
|
virtual void particles_set_collision_base_size(RID p_particles, float p_size) = 0;
|
|
virtual void particles_set_seed(RID p_particles, uint32_t p_seed) = 0;
|
|
|
|
virtual void particles_set_transform_align(RID p_particles, RSE::ParticlesTransformAlign p_transform_align) = 0;
|
|
|
|
virtual void particles_set_trails(RID p_particles, bool p_enable, float p_length_sec) = 0;
|
|
virtual void particles_set_trail_bind_poses(RID p_particles, const Vector<Transform3D> &p_bind_poses) = 0;
|
|
|
|
virtual bool particles_is_inactive(RID p_particles) = 0;
|
|
virtual void particles_request_process(RID p_particles) = 0;
|
|
virtual void particles_restart(RID p_particles) = 0;
|
|
|
|
virtual void particles_set_subemitter(RID p_particles, RID p_subemitter_particles) = 0;
|
|
|
|
virtual void particles_emit(RID p_particles, const Transform3D &p_transform, const Vector3 &p_velocity, const Color &p_color, const Color &p_custom, uint32_t p_emit_flags) = 0;
|
|
|
|
virtual void particles_set_draw_order(RID p_particles, RSE::ParticlesDrawOrder p_order) = 0;
|
|
|
|
virtual void particles_set_draw_passes(RID p_particles, int p_count) = 0;
|
|
virtual void particles_set_draw_pass_mesh(RID p_particles, int p_pass, RID p_mesh) = 0;
|
|
|
|
virtual AABB particles_get_current_aabb(RID p_particles) = 0;
|
|
|
|
virtual void particles_set_emission_transform(RID p_particles, const Transform3D &p_transform) = 0; // This is only used for 2D, in 3D it's automatic.
|
|
virtual void particles_set_emitter_velocity(RID p_particles, const Vector3 &p_velocity) = 0;
|
|
virtual void particles_set_interp_to_end(RID p_particles, float p_interp) = 0;
|
|
|
|
/* PARTICLES COLLISION API */
|
|
|
|
virtual RID particles_collision_create() = 0;
|
|
|
|
virtual void particles_collision_set_collision_type(RID p_particles_collision, RSE::ParticlesCollisionType p_type) = 0;
|
|
virtual void particles_collision_set_cull_mask(RID p_particles_collision, uint32_t p_cull_mask) = 0;
|
|
virtual void particles_collision_set_sphere_radius(RID p_particles_collision, real_t p_radius) = 0; // For spheres.
|
|
virtual void particles_collision_set_box_extents(RID p_particles_collision, const Vector3 &p_extents) = 0; // For non-spheres.
|
|
virtual void particles_collision_set_attractor_strength(RID p_particles_collision, real_t p_strength) = 0;
|
|
virtual void particles_collision_set_attractor_directionality(RID p_particles_collision, real_t p_directionality) = 0;
|
|
virtual void particles_collision_set_attractor_attenuation(RID p_particles_collision, real_t p_curve) = 0;
|
|
virtual void particles_collision_set_field_texture(RID p_particles_collision, RID p_texture) = 0; // For SDF and vector field, heightfield is dynamic.
|
|
|
|
virtual void particles_collision_height_field_update(RID p_particles_collision) = 0; // For SDF and vector field.
|
|
|
|
virtual void particles_collision_set_height_field_resolution(RID p_particles_collision, RSE::ParticlesCollisionHeightfieldResolution p_resolution) = 0; // For SDF and vector field.
|
|
virtual void particles_collision_set_height_field_mask(RID p_particles_collision, uint32_t p_heightfield_mask) = 0;
|
|
|
|
/* FOG VOLUME API */
|
|
|
|
virtual RID fog_volume_create() = 0;
|
|
|
|
virtual void fog_volume_set_shape(RID p_fog_volume, RSE::FogVolumeShape p_shape) = 0;
|
|
virtual void fog_volume_set_size(RID p_fog_volume, const Vector3 &p_size) = 0;
|
|
virtual void fog_volume_set_material(RID p_fog_volume, RID p_material) = 0;
|
|
|
|
/* VISIBILITY NOTIFIER API */
|
|
|
|
virtual RID visibility_notifier_create() = 0;
|
|
virtual void visibility_notifier_set_aabb(RID p_notifier, const AABB &p_aabb) = 0;
|
|
virtual void visibility_notifier_set_callbacks(RID p_notifier, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
|
|
|
|
/* OCCLUDER API */
|
|
|
|
virtual RID occluder_create() = 0;
|
|
virtual void occluder_set_mesh(RID p_occluder, const PackedVector3Array &p_vertices, const PackedInt32Array &p_indices) = 0;
|
|
|
|
/* CAMERA API */
|
|
|
|
virtual RID camera_create() = 0;
|
|
virtual void camera_set_perspective(RID p_camera, float p_fovy_degrees, float p_z_near, float p_z_far) = 0;
|
|
virtual void camera_set_orthogonal(RID p_camera, float p_size, float p_z_near, float p_z_far) = 0;
|
|
virtual void camera_set_frustum(RID p_camera, float p_size, Vector2 p_offset, float p_z_near, float p_z_far) = 0;
|
|
virtual void camera_set_transform(RID p_camera, const Transform3D &p_transform) = 0;
|
|
virtual void camera_set_cull_mask(RID p_camera, uint32_t p_layers) = 0;
|
|
virtual void camera_set_environment(RID p_camera, RID p_env) = 0;
|
|
virtual void camera_set_camera_attributes(RID p_camera, RID p_camera_attributes) = 0;
|
|
virtual void camera_set_compositor(RID p_camera, RID p_compositor) = 0;
|
|
virtual void camera_set_use_vertical_aspect(RID p_camera, bool p_enable) = 0;
|
|
|
|
/* VIEWPORT API */
|
|
|
|
virtual RID viewport_create() = 0;
|
|
|
|
#ifndef XR_DISABLED
|
|
virtual void viewport_set_use_xr(RID p_viewport, bool p_use_xr) = 0;
|
|
#endif // !XR_DISABLED
|
|
|
|
virtual void viewport_set_size(RID p_viewport, int p_width, int p_height, int p_view_count = 1) = 0;
|
|
virtual void viewport_set_active(RID p_viewport, bool p_active) = 0;
|
|
virtual void viewport_set_parent_viewport(RID p_viewport, RID p_parent_viewport) = 0;
|
|
virtual void viewport_set_canvas_cull_mask(RID p_viewport, uint32_t p_canvas_cull_mask) = 0;
|
|
|
|
virtual void viewport_attach_to_screen(RID p_viewport, const Rect2 &p_rect = Rect2(), DisplayServerEnums::WindowID p_screen = DisplayServerEnums::MAIN_WINDOW_ID) = 0;
|
|
virtual void viewport_set_render_direct_to_screen(RID p_viewport, bool p_enable) = 0;
|
|
|
|
virtual void viewport_set_scaling_3d_mode(RID p_viewport, RSE::ViewportScaling3DMode p_scaling_3d_mode) = 0;
|
|
virtual void viewport_set_scaling_3d_scale(RID p_viewport, float p_scaling_3d_scale) = 0;
|
|
virtual void viewport_set_fsr_sharpness(RID p_viewport, float p_fsr_sharpness) = 0;
|
|
virtual void viewport_set_texture_mipmap_bias(RID p_viewport, float p_texture_mipmap_bias) = 0;
|
|
virtual void viewport_set_anisotropic_filtering_level(RID p_viewport, RSE::ViewportAnisotropicFiltering p_anisotropic_filtering_level) = 0;
|
|
|
|
virtual void viewport_set_update_mode(RID p_viewport, RSE::ViewportUpdateMode p_mode) = 0;
|
|
virtual RSE::ViewportUpdateMode viewport_get_update_mode(RID p_viewport) const = 0;
|
|
|
|
virtual void viewport_set_clear_mode(RID p_viewport, RSE::ViewportClearMode p_clear_mode) = 0;
|
|
|
|
virtual RID viewport_get_render_target(RID p_viewport) const = 0;
|
|
virtual RID viewport_get_texture(RID p_viewport) const = 0;
|
|
|
|
virtual void viewport_set_environment_mode(RID p_viewport, RSE::ViewportEnvironmentMode p_mode) = 0;
|
|
virtual void viewport_set_disable_3d(RID p_viewport, bool p_disable) = 0;
|
|
virtual void viewport_set_disable_2d(RID p_viewport, bool p_disable) = 0;
|
|
|
|
virtual void viewport_attach_camera(RID p_viewport, RID p_camera) = 0;
|
|
virtual void viewport_set_scenario(RID p_viewport, RID p_scenario) = 0;
|
|
virtual void viewport_attach_canvas(RID p_viewport, RID p_canvas) = 0;
|
|
virtual void viewport_remove_canvas(RID p_viewport, RID p_canvas) = 0;
|
|
virtual void viewport_set_canvas_transform(RID p_viewport, RID p_canvas, const Transform2D &p_offset) = 0;
|
|
virtual void viewport_set_transparent_background(RID p_viewport, bool p_enabled) = 0;
|
|
virtual void viewport_set_use_hdr_2d(RID p_viewport, bool p_use_hdr) = 0;
|
|
virtual bool viewport_is_using_hdr_2d(RID p_viewport) const = 0;
|
|
virtual void viewport_set_snap_2d_transforms_to_pixel(RID p_viewport, bool p_enabled) = 0;
|
|
virtual void viewport_set_snap_2d_vertices_to_pixel(RID p_viewport, bool p_enabled) = 0;
|
|
|
|
virtual void viewport_set_default_canvas_item_texture_filter(RID p_viewport, RSE::CanvasItemTextureFilter p_filter) = 0;
|
|
virtual void viewport_set_default_canvas_item_texture_repeat(RID p_viewport, RSE::CanvasItemTextureRepeat p_repeat) = 0;
|
|
|
|
virtual void viewport_set_global_canvas_transform(RID p_viewport, const Transform2D &p_transform) = 0;
|
|
virtual void viewport_set_canvas_stacking(RID p_viewport, RID p_canvas, int p_layer, int p_sublayer) = 0;
|
|
|
|
virtual void viewport_set_sdf_oversize_and_scale(RID p_viewport, RSE::ViewportSDFOversize p_oversize, RSE::ViewportSDFScale p_scale) = 0;
|
|
|
|
virtual void viewport_set_positional_shadow_atlas_size(RID p_viewport, int p_size, bool p_16_bits = true) = 0;
|
|
virtual void viewport_set_positional_shadow_atlas_quadrant_subdivision(RID p_viewport, int p_quadrant, int p_subdiv) = 0;
|
|
|
|
virtual void viewport_set_msaa_3d(RID p_viewport, RSE::ViewportMSAA p_msaa) = 0;
|
|
virtual void viewport_set_msaa_2d(RID p_viewport, RSE::ViewportMSAA p_msaa) = 0;
|
|
|
|
virtual void viewport_set_screen_space_aa(RID p_viewport, RSE::ViewportScreenSpaceAA p_mode) = 0;
|
|
|
|
virtual void viewport_set_use_taa(RID p_viewport, bool p_use_taa) = 0;
|
|
|
|
virtual void viewport_set_use_debanding(RID p_viewport, bool p_use_debanding) = 0;
|
|
|
|
virtual void viewport_set_force_motion_vectors(RID p_viewport, bool p_force_motion_vectors) = 0;
|
|
|
|
virtual void viewport_set_mesh_lod_threshold(RID p_viewport, float p_pixels) = 0;
|
|
|
|
virtual void viewport_set_use_occlusion_culling(RID p_viewport, bool p_use_occlusion_culling) = 0;
|
|
virtual void viewport_set_occlusion_rays_per_thread(int p_rays_per_thread) = 0;
|
|
|
|
virtual void viewport_set_occlusion_culling_build_quality(RSE::ViewportOcclusionCullingBuildQuality p_quality) = 0;
|
|
|
|
virtual int viewport_get_render_info(RID p_viewport, RSE::ViewportRenderInfoType p_type, RSE::ViewportRenderInfo p_info) = 0;
|
|
|
|
virtual void viewport_set_debug_draw(RID p_viewport, RSE::ViewportDebugDraw p_draw) = 0;
|
|
|
|
virtual void viewport_set_measure_render_time(RID p_viewport, bool p_enable) = 0;
|
|
virtual double viewport_get_measured_render_time_cpu(RID p_viewport) const = 0;
|
|
virtual double viewport_get_measured_render_time_gpu(RID p_viewport) const = 0;
|
|
|
|
virtual RID viewport_find_from_screen_attachment(DisplayServerEnums::WindowID p_id = DisplayServerEnums::MAIN_WINDOW_ID) const = 0;
|
|
|
|
virtual void viewport_set_vrs_mode(RID p_viewport, RSE::ViewportVRSMode p_mode) = 0;
|
|
virtual void viewport_set_vrs_update_mode(RID p_viewport, RSE::ViewportVRSUpdateMode p_mode) = 0;
|
|
virtual void viewport_set_vrs_texture(RID p_viewport, RID p_texture) = 0;
|
|
|
|
/* SKY API */
|
|
|
|
virtual RID sky_create() = 0;
|
|
virtual void sky_set_radiance_size(RID p_sky, int p_radiance_size) = 0;
|
|
virtual void sky_set_mode(RID p_sky, RSE::SkyMode p_mode) = 0;
|
|
virtual void sky_set_material(RID p_sky, RID p_material) = 0;
|
|
virtual Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size) = 0;
|
|
|
|
/* COMPOSITOR EFFECTS API */
|
|
|
|
virtual RID compositor_effect_create() = 0;
|
|
virtual void compositor_effect_set_enabled(RID p_effect, bool p_enabled) = 0;
|
|
virtual void compositor_effect_set_callback(RID p_effect, RSE::CompositorEffectCallbackType p_callback_type, const Callable &p_callback) = 0;
|
|
virtual void compositor_effect_set_flag(RID p_effect, RSE::CompositorEffectFlags p_flag, bool p_set) = 0;
|
|
|
|
/* COMPOSITOR API */
|
|
|
|
virtual RID compositor_create() = 0;
|
|
|
|
virtual void compositor_set_compositor_effects(RID p_compositor, const TypedArray<RID> &p_effects) = 0;
|
|
|
|
/* ENVIRONMENT API */
|
|
|
|
virtual RID environment_create() = 0;
|
|
|
|
virtual void environment_set_background(RID p_env, RSE::EnvironmentBG p_bg) = 0;
|
|
virtual void environment_set_sky(RID p_env, RID p_sky) = 0;
|
|
virtual void environment_set_sky_custom_fov(RID p_env, float p_scale) = 0;
|
|
virtual void environment_set_sky_orientation(RID p_env, const Basis &p_orientation) = 0;
|
|
virtual void environment_set_bg_color(RID p_env, const Color &p_color) = 0;
|
|
virtual void environment_set_bg_energy(RID p_env, float p_multiplier, float p_exposure_value) = 0;
|
|
virtual void environment_set_canvas_max_layer(RID p_env, int p_max_layer) = 0;
|
|
virtual void environment_set_ambient_light(RID p_env, const Color &p_color, RSE::EnvironmentAmbientSource p_ambient = RSE::ENV_AMBIENT_SOURCE_BG, float p_energy = 1.0, float p_sky_contribution = 0.0, RSE::EnvironmentReflectionSource p_reflection_source = RSE::ENV_REFLECTION_SOURCE_BG) = 0;
|
|
virtual void environment_set_camera_feed_id(RID p_env, int p_camera_feed_id) = 0;
|
|
|
|
virtual void environment_set_glow(RID p_env, bool p_enable, Vector<float> p_levels, float p_intensity, float p_strength, float p_mix, float p_bloom_threshold, RSE::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;
|
|
|
|
virtual void environment_glow_set_use_bicubic_upscale(bool p_enable) = 0;
|
|
|
|
virtual void environment_set_tonemap(RID p_env, RSE::EnvironmentToneMapper p_tone_mapper, float p_exposure, float p_white) = 0;
|
|
virtual void environment_set_tonemap_agx_contrast(RID p_env, float p_agx_contrast) = 0;
|
|
virtual void environment_set_adjustment(RID p_env, bool p_enable, float p_brightness, float p_contrast, float p_saturation, bool p_use_1d_color_correction, RID p_color_correction) = 0;
|
|
|
|
virtual void environment_set_ssr(RID p_env, bool p_enable, int p_max_steps, float p_fade_in, float p_fade_out, float p_depth_tolerance) = 0;
|
|
|
|
virtual void environment_set_ssr_half_size(bool p_half_size) = 0;
|
|
|
|
virtual void environment_set_ssr_roughness_quality(RSE::EnvironmentSSRRoughnessQuality p_quality) = 0;
|
|
|
|
virtual void environment_set_ssao(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_power, float p_detail, float p_horizon, float p_sharpness, float p_light_affect, float p_ao_channel_affect) = 0;
|
|
|
|
virtual void environment_set_ssao_quality(RSE::EnvironmentSSAOQuality p_quality, bool p_half_size, float p_adaptive_target, int p_blur_passes, float p_fadeout_from, float p_fadeout_to) = 0;
|
|
|
|
virtual void environment_set_ssil(RID p_env, bool p_enable, float p_radius, float p_intensity, float p_sharpness, float p_normal_rejection) = 0;
|
|
|
|
virtual void environment_set_ssil_quality(RSE::EnvironmentSSILQuality p_quality, bool p_half_size, float p_adaptive_target, int p_blur_passes, float p_fadeout_from, float p_fadeout_to) = 0;
|
|
|
|
virtual void environment_set_sdfgi(RID p_env, bool p_enable, int p_cascades, float p_min_cell_size, RSE::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;
|
|
|
|
virtual void environment_set_sdfgi_ray_count(RSE::EnvironmentSDFGIRayCount p_ray_count) = 0;
|
|
|
|
virtual void environment_set_sdfgi_frames_to_converge(RSE::EnvironmentSDFGIFramesToConverge p_frames) = 0;
|
|
|
|
virtual void environment_set_sdfgi_frames_to_update_light(RSE::EnvironmentSDFGIFramesToUpdateLight p_update) = 0;
|
|
|
|
virtual void environment_set_fog(RID p_env, bool p_enable, const Color &p_light_color, float p_light_energy, float p_sun_scatter, float p_density, float p_height, float p_height_density, float p_aerial_perspective, float p_sky_affect, RSE::EnvironmentFogMode p_mode = RSE::EnvironmentFogMode::ENV_FOG_MODE_EXPONENTIAL) = 0;
|
|
virtual void environment_set_fog_depth(RID p_env, float p_curve, float p_begin, float p_end) = 0;
|
|
|
|
virtual void environment_set_volumetric_fog(RID p_env, bool p_enable, float p_density, const Color &p_albedo, const Color &p_emission, float p_emission_energy, float p_anisotropy, float p_length, float p_detail_spread, float p_gi_inject, bool p_temporal_reprojection, float p_temporal_reprojection_amount, float p_ambient_inject, float p_sky_affect) = 0;
|
|
virtual void environment_set_volumetric_fog_volume_size(int p_size, int p_depth) = 0;
|
|
virtual void environment_set_volumetric_fog_filter_active(bool p_enable) = 0;
|
|
|
|
virtual Ref<Image> environment_bake_panorama(RID p_env, bool p_bake_irradiance, const Size2i &p_size) = 0;
|
|
|
|
virtual void screen_space_roughness_limiter_set_active(bool p_enable, float p_amount, float p_limit) = 0;
|
|
|
|
virtual void sub_surface_scattering_set_quality(RSE::SubSurfaceScatteringQuality p_quality) = 0;
|
|
virtual void sub_surface_scattering_set_scale(float p_scale, float p_depth_scale) = 0;
|
|
|
|
/* CAMERA ATTRIBUTES API */
|
|
|
|
virtual RID camera_attributes_create() = 0;
|
|
|
|
virtual void camera_attributes_set_dof_blur_quality(RSE::DOFBlurQuality p_quality, bool p_use_jitter) = 0;
|
|
|
|
virtual void camera_attributes_set_dof_blur_bokeh_shape(RSE::DOFBokehShape p_shape) = 0;
|
|
|
|
virtual void camera_attributes_set_dof_blur(RID p_camera_attributes, bool p_far_enable, float p_far_distance, float p_far_transition, bool p_near_enable, float p_near_distance, float p_near_transition, float p_amount) = 0;
|
|
virtual void camera_attributes_set_exposure(RID p_camera_attributes, float p_multiplier, float p_exposure_normalization) = 0;
|
|
virtual void camera_attributes_set_auto_exposure(RID p_camera_attributes, bool p_enable, float p_min_sensitivity, float p_max_sensitivity, float p_speed, float p_scale) = 0;
|
|
|
|
/* SCENARIO API */
|
|
|
|
virtual RID scenario_create() = 0;
|
|
|
|
virtual void scenario_set_environment(RID p_scenario, RID p_environment) = 0;
|
|
virtual void scenario_set_fallback_environment(RID p_scenario, RID p_environment) = 0;
|
|
virtual void scenario_set_camera_attributes(RID p_scenario, RID p_camera_attributes) = 0;
|
|
virtual void scenario_set_compositor(RID p_scenario, RID p_compositor) = 0;
|
|
|
|
/* INSTANCING API */
|
|
|
|
virtual RID instance_create2(RID p_base, RID p_scenario);
|
|
|
|
virtual RID instance_create() = 0;
|
|
|
|
virtual void instance_set_base(RID p_instance, RID p_base) = 0;
|
|
virtual void instance_set_scenario(RID p_instance, RID p_scenario) = 0;
|
|
virtual void instance_set_layer_mask(RID p_instance, uint32_t p_mask) = 0;
|
|
virtual void instance_set_pivot_data(RID p_instance, float p_sorting_offset, bool p_use_aabb_center) = 0;
|
|
virtual void instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;
|
|
virtual void instance_attach_object_instance_id(RID p_instance, ObjectID p_id) = 0;
|
|
virtual void instance_set_blend_shape_weight(RID p_instance, int p_shape, float p_weight) = 0;
|
|
virtual void instance_set_surface_override_material(RID p_instance, int p_surface, RID p_material) = 0;
|
|
virtual void instance_set_visible(RID p_instance, bool p_visible) = 0;
|
|
|
|
virtual void instance_teleport(RID p_instance) = 0;
|
|
|
|
virtual void instance_set_custom_aabb(RID p_instance, AABB aabb) = 0;
|
|
|
|
virtual void instance_attach_skeleton(RID p_instance, RID p_skeleton) = 0;
|
|
|
|
virtual void instance_set_extra_visibility_margin(RID p_instance, real_t p_margin) = 0;
|
|
virtual void instance_set_visibility_parent(RID p_instance, RID p_parent_instance) = 0;
|
|
|
|
virtual void instance_set_ignore_culling(RID p_instance, bool p_enabled) = 0;
|
|
|
|
// Don't use these in a game!
|
|
virtual Vector<ObjectID> instances_cull_aabb(const AABB &p_aabb, RID p_scenario = RID()) const = 0;
|
|
virtual Vector<ObjectID> instances_cull_ray(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const = 0;
|
|
virtual Vector<ObjectID> instances_cull_convex(const Vector<Plane> &p_convex, RID p_scenario = RID()) const = 0;
|
|
|
|
PackedInt64Array _instances_cull_aabb_bind(const AABB &p_aabb, RID p_scenario = RID()) const;
|
|
PackedInt64Array _instances_cull_ray_bind(const Vector3 &p_from, const Vector3 &p_to, RID p_scenario = RID()) const;
|
|
PackedInt64Array _instances_cull_convex_bind(const TypedArray<Plane> &p_convex, RID p_scenario = RID()) const;
|
|
|
|
virtual void instance_geometry_set_flag(RID p_instance, RSE::InstanceFlags p_flags, bool p_enabled) = 0;
|
|
virtual void instance_geometry_set_cast_shadows_setting(RID p_instance, RSE::ShadowCastingSetting p_shadow_casting_setting) = 0;
|
|
virtual void instance_geometry_set_material_override(RID p_instance, RID p_material) = 0;
|
|
virtual void instance_geometry_set_material_overlay(RID p_instance, RID p_material) = 0;
|
|
virtual void instance_geometry_set_visibility_range(RID p_instance, float p_min, float p_max, float p_min_margin, float p_max_margin, RSE::VisibilityRangeFadeMode p_fade_mode) = 0;
|
|
virtual void instance_geometry_set_lightmap(RID p_instance, RID p_lightmap, const Rect2 &p_lightmap_uv_scale, int p_lightmap_slice) = 0;
|
|
virtual void instance_geometry_set_lod_bias(RID p_instance, float p_lod_bias) = 0;
|
|
virtual void instance_geometry_set_transparency(RID p_instance, float p_transparency) = 0;
|
|
|
|
virtual void instance_geometry_set_shader_parameter(RID p_instance, const StringName &, const Variant &p_value) = 0;
|
|
virtual Variant instance_geometry_get_shader_parameter(RID p_instance, const StringName &) const = 0;
|
|
virtual Variant instance_geometry_get_shader_parameter_default_value(RID p_instance, const StringName &) const = 0;
|
|
virtual void instance_geometry_get_shader_parameter_list(RID p_instance, List<PropertyInfo> *p_parameters) const = 0;
|
|
|
|
/* BAKE API */
|
|
|
|
virtual TypedArray<Image> bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size) = 0;
|
|
|
|
/* CANVAS API (2D) */
|
|
|
|
virtual RID canvas_create() = 0;
|
|
virtual void canvas_set_item_mirroring(RID p_canvas, RID p_item, const Point2 &p_mirroring) = 0;
|
|
virtual void canvas_set_item_repeat(RID p_item, const Point2 &p_repeat_size, int p_repeat_times) = 0;
|
|
virtual void canvas_set_modulate(RID p_canvas, const Color &p_color) = 0;
|
|
virtual void canvas_set_parent(RID p_canvas, RID p_parent, float p_scale) = 0;
|
|
|
|
virtual void canvas_set_disable_scale(bool p_disable) = 0;
|
|
|
|
/* CANVAS TEXTURE API*/
|
|
|
|
virtual RID canvas_texture_create() = 0;
|
|
virtual void canvas_texture_set_channel(RID p_canvas_texture, RSE::CanvasTextureChannel p_channel, RID p_texture) = 0;
|
|
virtual void canvas_texture_set_shading_parameters(RID p_canvas_texture, const Color &p_base_color, float p_shininess) = 0;
|
|
|
|
// Takes effect only for new draw commands.
|
|
virtual void canvas_texture_set_texture_filter(RID p_canvas_texture, RSE::CanvasItemTextureFilter p_filter) = 0;
|
|
virtual void canvas_texture_set_texture_repeat(RID p_canvas_texture, RSE::CanvasItemTextureRepeat p_repeat) = 0;
|
|
|
|
/* CANVAS ITEM API */
|
|
|
|
virtual RID canvas_item_create() = 0;
|
|
virtual void canvas_item_set_parent(RID p_item, RID p_parent) = 0;
|
|
|
|
virtual void canvas_item_set_default_texture_filter(RID p_item, RSE::CanvasItemTextureFilter p_filter) = 0;
|
|
virtual void canvas_item_set_default_texture_repeat(RID p_item, RSE::CanvasItemTextureRepeat p_repeat) = 0;
|
|
|
|
virtual void canvas_item_set_visible(RID p_item, bool p_visible) = 0;
|
|
virtual void canvas_item_set_light_mask(RID p_item, int p_mask) = 0;
|
|
|
|
virtual void canvas_item_set_update_when_visible(RID p_item, bool p_update) = 0;
|
|
|
|
virtual void canvas_item_set_transform(RID p_item, const Transform2D &p_transform) = 0;
|
|
virtual void canvas_item_set_clip(RID p_item, bool p_clip) = 0;
|
|
virtual void canvas_item_set_distance_field_mode(RID p_item, bool p_enable) = 0;
|
|
virtual void canvas_item_set_custom_rect(RID p_item, bool p_custom_rect, const Rect2 &p_rect = Rect2()) = 0;
|
|
virtual void canvas_item_set_modulate(RID p_item, const Color &p_color) = 0;
|
|
virtual void canvas_item_set_self_modulate(RID p_item, const Color &p_color) = 0;
|
|
virtual void canvas_item_set_visibility_layer(RID p_item, uint32_t p_visibility_layer) = 0;
|
|
|
|
virtual void canvas_item_set_draw_behind_parent(RID p_item, bool p_enable) = 0;
|
|
virtual void canvas_item_set_use_identity_transform(RID p_item, bool p_enabled) = 0;
|
|
|
|
virtual void canvas_item_add_line(RID p_item, const Point2 &p_from, const Point2 &p_to, const Color &p_color, float p_width = -1.0, bool p_antialiased = false) = 0;
|
|
virtual void canvas_item_add_polyline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0, bool p_antialiased = false) = 0;
|
|
virtual void canvas_item_add_multiline(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, float p_width = -1.0, bool p_antialiased = false) = 0;
|
|
virtual void canvas_item_add_rect(RID p_item, const Rect2 &p_rect, const Color &p_color, bool p_antialiased = false) = 0;
|
|
virtual void canvas_item_add_ellipse(RID p_item, const Point2 &p_pos, float p_major, float p_minor, const Color &p_color, bool p_antialiased = false) = 0;
|
|
virtual void canvas_item_add_circle(RID p_item, const Point2 &p_pos, float p_radius, const Color &p_color, bool p_antialiased = false) = 0;
|
|
virtual void canvas_item_add_texture_rect(RID p_item, const Rect2 &p_rect, RID p_texture, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false) = 0;
|
|
virtual void canvas_item_add_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, bool p_clip_uv = false) = 0;
|
|
virtual void canvas_item_add_msdf_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), int p_outline_size = 0, float p_px_range = 1.0, float p_scale = 1.0) = 0;
|
|
virtual void canvas_item_add_lcd_texture_rect_region(RID p_item, const Rect2 &p_rect, RID p_texture, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1)) = 0;
|
|
virtual void canvas_item_add_nine_patch(RID p_item, const Rect2 &p_rect, const Rect2 &p_source, RID p_texture, const Vector2 &p_topleft, const Vector2 &p_bottomright, RSE::NinePatchAxisMode p_x_axis_mode = RSE::NINE_PATCH_STRETCH, RSE::NinePatchAxisMode p_y_axis_mode = RSE::NINE_PATCH_STRETCH, bool p_draw_center = true, const Color &p_modulate = Color(1, 1, 1)) = 0;
|
|
virtual void canvas_item_add_primitive(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs, RID p_texture) = 0;
|
|
virtual void canvas_item_add_polygon(RID p_item, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs = Vector<Point2>(), RID p_texture = RID()) = 0;
|
|
virtual void canvas_item_add_triangle_array(RID p_item, const Vector<int> &p_indices, const Vector<Point2> &p_points, const Vector<Color> &p_colors, const Vector<Point2> &p_uvs = Vector<Point2>(), const Vector<int> &p_bones = Vector<int>(), const Vector<float> &p_weights = Vector<float>(), RID p_texture = RID(), int p_count = -1) = 0;
|
|
virtual void canvas_item_add_mesh(RID p_item, const RID &p_mesh, const Transform2D &p_transform = Transform2D(), const Color &p_modulate = Color(1, 1, 1), RID p_texture = RID()) = 0;
|
|
virtual void canvas_item_add_multimesh(RID p_item, RID p_mesh, RID p_texture = RID()) = 0;
|
|
virtual void canvas_item_add_particles(RID p_item, RID p_particles, RID p_texture) = 0;
|
|
virtual void canvas_item_add_set_transform(RID p_item, const Transform2D &p_transform) = 0;
|
|
virtual void canvas_item_add_clip_ignore(RID p_item, bool p_ignore) = 0;
|
|
virtual void canvas_item_add_animation_slice(RID p_item, double p_animation_length, double p_slice_begin, double p_slice_end, double p_offset) = 0;
|
|
|
|
virtual void canvas_item_set_sort_children_by_y(RID p_item, bool p_enable) = 0;
|
|
virtual void canvas_item_set_z_index(RID p_item, int p_z) = 0;
|
|
virtual void canvas_item_set_z_as_relative_to_parent(RID p_item, bool p_enable) = 0;
|
|
virtual void canvas_item_set_copy_to_backbuffer(RID p_item, bool p_enable, const Rect2 &p_rect) = 0;
|
|
|
|
virtual void canvas_item_attach_skeleton(RID p_item, RID p_skeleton) = 0;
|
|
|
|
virtual void canvas_item_clear(RID p_item) = 0;
|
|
virtual void canvas_item_set_draw_index(RID p_item, int p_index) = 0;
|
|
|
|
virtual void canvas_item_set_material(RID p_item, RID p_material) = 0;
|
|
|
|
virtual void canvas_item_set_use_parent_material(RID p_item, bool p_enable) = 0;
|
|
|
|
virtual void canvas_item_set_instance_shader_parameter(RID p_item, const StringName &, const Variant &p_value) = 0;
|
|
virtual Variant canvas_item_get_instance_shader_parameter(RID p_item, const StringName &) const = 0;
|
|
virtual Variant canvas_item_get_instance_shader_parameter_default_value(RID p_item, const StringName &) const = 0;
|
|
virtual void canvas_item_get_instance_shader_parameter_list(RID p_item, List<PropertyInfo> *p_parameters) const = 0;
|
|
|
|
virtual void canvas_item_set_visibility_notifier(RID p_item, bool p_enable, const Rect2 &p_area, const Callable &p_enter_callbable, const Callable &p_exit_callable) = 0;
|
|
|
|
virtual void canvas_item_set_canvas_group_mode(RID p_item, RSE::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;
|
|
|
|
virtual void canvas_item_set_debug_redraw(bool p_enabled) = 0;
|
|
virtual bool canvas_item_get_debug_redraw() const = 0;
|
|
|
|
virtual void canvas_item_set_interpolated(RID p_item, bool p_interpolated) = 0;
|
|
virtual void canvas_item_reset_physics_interpolation(RID p_item) = 0;
|
|
virtual void canvas_item_transform_physics_interpolation(RID p_item, const Transform2D &p_transform) = 0;
|
|
|
|
/* CANVAS LIGHT */
|
|
|
|
virtual RID canvas_light_create() = 0;
|
|
|
|
virtual void canvas_light_set_mode(RID p_light, RSE::CanvasLightMode p_mode) = 0;
|
|
|
|
virtual void canvas_light_attach_to_canvas(RID p_light, RID p_canvas) = 0;
|
|
virtual void canvas_light_set_enabled(RID p_light, bool p_enabled) = 0;
|
|
virtual void canvas_light_set_transform(RID p_light, const Transform2D &p_transform) = 0;
|
|
virtual void canvas_light_set_color(RID p_light, const Color &p_color) = 0;
|
|
virtual void canvas_light_set_height(RID p_light, float p_height) = 0;
|
|
virtual void canvas_light_set_energy(RID p_light, float p_energy) = 0;
|
|
virtual void canvas_light_set_z_range(RID p_light, int p_min_z, int p_max_z) = 0;
|
|
virtual void canvas_light_set_layer_range(RID p_light, int p_min_layer, int p_max_layer) = 0;
|
|
virtual void canvas_light_set_item_cull_mask(RID p_light, int p_mask) = 0;
|
|
virtual void canvas_light_set_item_shadow_cull_mask(RID p_light, int p_mask) = 0;
|
|
|
|
virtual void canvas_light_set_directional_distance(RID p_light, float p_distance) = 0;
|
|
|
|
virtual void canvas_light_set_texture_scale(RID p_light, float p_scale) = 0;
|
|
virtual void canvas_light_set_texture(RID p_light, RID p_texture) = 0;
|
|
virtual void canvas_light_set_texture_offset(RID p_light, const Vector2 &p_offset) = 0;
|
|
|
|
virtual void canvas_light_set_blend_mode(RID p_light, RSE::CanvasLightBlendMode p_mode) = 0;
|
|
|
|
virtual void canvas_light_set_shadow_enabled(RID p_light, bool p_enabled) = 0;
|
|
virtual void canvas_light_set_shadow_filter(RID p_light, RSE::CanvasLightShadowFilter p_filter) = 0;
|
|
virtual void canvas_light_set_shadow_color(RID p_light, const Color &p_color) = 0;
|
|
virtual void canvas_light_set_shadow_smooth(RID p_light, float p_smooth) = 0;
|
|
|
|
virtual void canvas_light_set_interpolated(RID p_light, bool p_interpolated) = 0;
|
|
virtual void canvas_light_reset_physics_interpolation(RID p_light) = 0;
|
|
virtual void canvas_light_transform_physics_interpolation(RID p_light, const Transform2D &p_transform) = 0;
|
|
|
|
/* CANVAS LIGHT OCCLUDER API */
|
|
|
|
virtual RID canvas_light_occluder_create() = 0;
|
|
virtual void canvas_light_occluder_attach_to_canvas(RID p_occluder, RID p_canvas) = 0;
|
|
virtual void canvas_light_occluder_set_enabled(RID p_occluder, bool p_enabled) = 0;
|
|
virtual void canvas_light_occluder_set_polygon(RID p_occluder, RID p_polygon) = 0;
|
|
virtual void canvas_light_occluder_set_as_sdf_collision(RID p_occluder, bool p_enable) = 0;
|
|
virtual void canvas_light_occluder_set_transform(RID p_occluder, const Transform2D &p_xform) = 0;
|
|
virtual void canvas_light_occluder_set_light_mask(RID p_occluder, int p_mask) = 0;
|
|
|
|
virtual void canvas_light_occluder_set_interpolated(RID p_occluder, bool p_interpolated) = 0;
|
|
virtual void canvas_light_occluder_reset_physics_interpolation(RID p_occluder) = 0;
|
|
virtual void canvas_light_occluder_transform_physics_interpolation(RID p_occluder, const Transform2D &p_transform) = 0;
|
|
|
|
/* CANVAS OCCLUDER POLYGON API */
|
|
|
|
virtual RID canvas_occluder_polygon_create() = 0;
|
|
virtual void canvas_occluder_polygon_set_shape(RID p_occluder_polygon, const Vector<Vector2> &p_shape, bool p_closed) = 0;
|
|
|
|
virtual void canvas_occluder_polygon_set_cull_mode(RID p_occluder_polygon, RSE::CanvasOccluderPolygonCullMode p_mode) = 0;
|
|
|
|
virtual void canvas_set_shadow_texture_size(int p_size) = 0;
|
|
|
|
Rect2 debug_canvas_item_get_rect(RID p_item);
|
|
virtual Rect2 _debug_canvas_item_get_rect(RID p_item) = 0;
|
|
|
|
/* GLOBAL SHADER PARAMETERS API */
|
|
|
|
virtual void global_shader_parameter_add(const StringName &p_name, RSE::GlobalShaderParameterType p_type, const Variant &p_value) = 0;
|
|
virtual void global_shader_parameter_remove(const StringName &p_name) = 0;
|
|
virtual Vector<StringName> global_shader_parameter_get_list() const = 0;
|
|
|
|
virtual void global_shader_parameter_set(const StringName &p_name, const Variant &p_value) = 0;
|
|
virtual void global_shader_parameter_set_override(const StringName &p_name, const Variant &p_value) = 0;
|
|
|
|
virtual Variant global_shader_parameter_get(const StringName &p_name) const = 0;
|
|
virtual RSE::GlobalShaderParameterType global_shader_parameter_get_type(const StringName &p_name) const = 0;
|
|
|
|
virtual void global_shader_parameters_load_settings(bool p_load_textures) = 0;
|
|
virtual void global_shader_parameters_clear() = 0;
|
|
|
|
static int global_shader_uniform_type_get_shader_datatype(RSE::GlobalShaderParameterType p_type);
|
|
|
|
/* FREE */
|
|
|
|
virtual void free_rid(RID p_rid) = 0; // Free RIDs associated with the rendering server.
|
|
#ifndef DISABLE_DEPRECATED
|
|
[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) {
|
|
free_rid(p_rid);
|
|
}
|
|
#endif // DISABLE_DEPRECATED
|
|
|
|
/* INTERPOLATION */
|
|
|
|
virtual void set_physics_interpolation_enabled(bool p_enabled) = 0;
|
|
|
|
/* EVENT QUEUING */
|
|
|
|
virtual void request_frame_drawn_callback(const Callable &p_callable) = 0;
|
|
|
|
virtual void draw(bool p_swap_buffers = true, double frame_step = 0.0) = 0;
|
|
virtual void sync() = 0;
|
|
virtual bool has_changed() const = 0;
|
|
virtual void init();
|
|
virtual void finish() = 0;
|
|
virtual void tick() = 0;
|
|
virtual void pre_draw(bool p_will_draw) = 0;
|
|
|
|
/* STATUS INFORMATION */
|
|
|
|
virtual uint64_t get_rendering_info(RSE::RenderingInfo p_info) = 0;
|
|
virtual String get_video_adapter_name() const = 0;
|
|
virtual String get_video_adapter_vendor() const = 0;
|
|
virtual RenderingDeviceEnums::DeviceType get_video_adapter_type() const = 0;
|
|
virtual String get_video_adapter_api_version() const = 0;
|
|
|
|
virtual void set_frame_profiling_enabled(bool p_enable) = 0;
|
|
virtual Vector<RenderingServerTypes::FrameProfileArea> get_frame_profile() = 0;
|
|
virtual uint64_t get_frame_profile_frame() = 0;
|
|
|
|
virtual double get_frame_setup_time_cpu() const = 0;
|
|
|
|
virtual void gi_set_use_half_resolution(bool p_enable) = 0;
|
|
|
|
/* TESTING */
|
|
|
|
virtual RID get_test_cube() = 0;
|
|
|
|
virtual RID get_test_texture();
|
|
virtual RID get_white_texture();
|
|
|
|
virtual void sdfgi_set_debug_probe_select(const Vector3 &p_position, const Vector3 &p_dir) = 0;
|
|
|
|
virtual RID make_sphere_mesh(int p_lats, int p_lons, real_t p_radius);
|
|
|
|
virtual void mesh_add_surface_from_mesh_data(RID p_mesh, const Geometry3D::MeshData &p_mesh_data);
|
|
virtual void mesh_add_surface_from_planes(RID p_mesh, const Vector<Plane> &p_planes);
|
|
|
|
/* BACKGROUND */
|
|
|
|
virtual void set_boot_image_with_stretch(const Ref<Image> &p_image, const Color &p_color, RSE::SplashStretchMode p_stretch_mode, bool p_use_filter = true) = 0;
|
|
#ifndef DISABLE_DEPRECATED
|
|
void set_boot_image(const Ref<Image> &p_image, const Color &p_color, bool p_scale, bool p_use_filter = true); // Superseded, but left to preserve compat.
|
|
#endif
|
|
|
|
virtual Color get_default_clear_color() = 0;
|
|
virtual void set_default_clear_color(const Color &p_color) = 0;
|
|
|
|
/* MISC */
|
|
|
|
#ifndef DISABLE_DEPRECATED
|
|
// Never actually used, should be removed when we can break compatibility.
|
|
virtual bool has_feature(RSE::Features p_feature) const = 0;
|
|
#endif
|
|
virtual bool has_os_feature(const String &p_feature) const = 0;
|
|
|
|
virtual void set_debug_generate_wireframes(bool p_generate) = 0;
|
|
|
|
virtual void call_set_vsync_mode(DisplayServerEnums::VSyncMode p_mode, DisplayServerEnums::WindowID p_window) = 0;
|
|
|
|
virtual bool is_low_end() const = 0;
|
|
|
|
virtual void set_print_gpu_profile(bool p_enable) = 0;
|
|
|
|
virtual Size2i get_maximum_viewport_size() const = 0;
|
|
|
|
RenderingDevice *get_rendering_device() const;
|
|
RenderingDevice *create_local_rendering_device() const;
|
|
|
|
bool is_render_loop_enabled() const;
|
|
void set_render_loop_enabled(bool p_enabled);
|
|
|
|
virtual bool is_on_render_thread() = 0;
|
|
virtual void call_on_render_thread(const Callable &p_callable) = 0;
|
|
|
|
String get_current_rendering_driver_name() const;
|
|
String get_current_rendering_method() const;
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const override;
|
|
#endif
|
|
|
|
RenderingServer();
|
|
virtual ~RenderingServer();
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
typedef void (*SurfaceUpgradeCallback)();
|
|
void set_surface_upgrade_callback(SurfaceUpgradeCallback p_callback);
|
|
void set_warn_on_surface_upgrade(bool p_warn);
|
|
#endif
|
|
|
|
#ifndef DISABLE_DEPRECATED
|
|
void fix_surface_compatibility(RenderingServerTypes::SurfaceData &p_surface, const String &p_path = "");
|
|
#endif
|
|
|
|
private:
|
|
// Binder helpers
|
|
RID _texture_2d_layered_create(const TypedArray<Image> &p_layers, RSE::TextureLayeredType p_layered_type);
|
|
RID _texture_3d_create(Image::Format p_format, int p_width, int p_height, int p_depth, bool p_mipmaps, const TypedArray<Image> &p_data);
|
|
void _texture_3d_update(RID p_texture, const TypedArray<Image> &p_data);
|
|
TypedArray<Image> _texture_3d_get(RID p_texture) const;
|
|
TypedArray<Dictionary> _shader_get_shader_parameter_list(RID p_shader) const;
|
|
RID _mesh_create_from_surfaces(const TypedArray<Dictionary> &p_surfaces, int p_blend_shape_count);
|
|
void _mesh_add_surface(RID p_mesh, const Dictionary &p_surface);
|
|
Dictionary _mesh_get_surface(RID p_mesh, int p_idx);
|
|
TypedArray<Dictionary> _instance_geometry_get_shader_parameter_list(RID p_instance) const;
|
|
TypedArray<Dictionary> _canvas_item_get_instance_shader_parameter_list(RID p_item) const;
|
|
TypedArray<Image> _bake_render_uv2(RID p_base, const TypedArray<RID> &p_material_overrides, const Size2i &p_image_size);
|
|
void _particles_set_trail_bind_poses(RID p_particles, const TypedArray<Transform3D> &p_bind_poses);
|
|
#ifdef TOOLS_ENABLED
|
|
SurfaceUpgradeCallback surface_upgrade_callback = nullptr;
|
|
bool warn_on_surface_upgrade = true;
|
|
#endif
|
|
};
|
|
|
|
// Make variant understand the enums.
|
|
VARIANT_ENUM_CAST_EXT(RSE::TextureType, RenderingServer::TextureType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::TextureLayeredType, RenderingServer::TextureLayeredType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CubeMapLayer, RenderingServer::CubeMapLayer);
|
|
VARIANT_ENUM_CAST_EXT(RSE::TextureDrawableFormat, RenderingServer::TextureDrawableFormat);
|
|
VARIANT_ENUM_CAST_EXT(RSE::PipelineSource, RenderingServer::PipelineSource);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ShaderMode, RenderingServer::ShaderMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ArrayType, RenderingServer::ArrayType);
|
|
VARIANT_BITFIELD_CAST_EXT(RSE::ArrayFormat, RenderingServer::ArrayFormat);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ArrayCustomFormat, RenderingServer::ArrayCustomFormat);
|
|
VARIANT_ENUM_CAST_EXT(RSE::PrimitiveType, RenderingServer::PrimitiveType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::BlendShapeMode, RenderingServer::BlendShapeMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::MultimeshTransformFormat, RenderingServer::MultimeshTransformFormat);
|
|
VARIANT_ENUM_CAST_EXT(RSE::MultimeshPhysicsInterpolationQuality, RenderingServer::MultimeshPhysicsInterpolationQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightType, RenderingServer::LightType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightParam, RenderingServer::LightParam);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightBakeMode, RenderingServer::LightBakeMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightOmniShadowMode, RenderingServer::LightOmniShadowMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightDirectionalShadowMode, RenderingServer::LightDirectionalShadowMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightDirectionalSkyMode, RenderingServer::LightDirectionalSkyMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::LightProjectorFilter, RenderingServer::LightProjectorFilter);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ReflectionProbeUpdateMode, RenderingServer::ReflectionProbeUpdateMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ReflectionProbeAmbientMode, RenderingServer::ReflectionProbeAmbientMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::VoxelGIQuality, RenderingServer::VoxelGIQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::DecalTexture, RenderingServer::DecalTexture);
|
|
VARIANT_ENUM_CAST_EXT(RSE::DecalFilter, RenderingServer::DecalFilter);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ParticlesMode, RenderingServer::ParticlesMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ParticlesTransformAlign, RenderingServer::ParticlesTransformAlign);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ParticlesDrawOrder, RenderingServer::ParticlesDrawOrder);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ParticlesEmitFlags, RenderingServer::ParticlesEmitFlags);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ParticlesCollisionType, RenderingServer::ParticlesCollisionType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ParticlesCollisionHeightfieldResolution, RenderingServer::ParticlesCollisionHeightfieldResolution);
|
|
VARIANT_ENUM_CAST_EXT(RSE::FogVolumeShape, RenderingServer::FogVolumeShape);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportScaling3DMode, RenderingServer::ViewportScaling3DMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportUpdateMode, RenderingServer::ViewportUpdateMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportClearMode, RenderingServer::ViewportClearMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportEnvironmentMode, RenderingServer::ViewportEnvironmentMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportMSAA, RenderingServer::ViewportMSAA);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportAnisotropicFiltering, RenderingServer::ViewportAnisotropicFiltering);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportScreenSpaceAA, RenderingServer::ViewportScreenSpaceAA);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportRenderInfo, RenderingServer::ViewportRenderInfo);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportRenderInfoType, RenderingServer::ViewportRenderInfoType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportDebugDraw, RenderingServer::ViewportDebugDraw);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportOcclusionCullingBuildQuality, RenderingServer::ViewportOcclusionCullingBuildQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportSDFOversize, RenderingServer::ViewportSDFOversize);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportSDFScale, RenderingServer::ViewportSDFScale);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportVRSMode, RenderingServer::ViewportVRSMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ViewportVRSUpdateMode, RenderingServer::ViewportVRSUpdateMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::SkyMode, RenderingServer::SkyMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CompositorEffectCallbackType, RenderingServer::CompositorEffectCallbackType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CompositorEffectFlags, RenderingServer::CompositorEffectFlags);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentBG, RenderingServer::EnvironmentBG);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentAmbientSource, RenderingServer::EnvironmentAmbientSource);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentReflectionSource, RenderingServer::EnvironmentReflectionSource);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentGlowBlendMode, RenderingServer::EnvironmentGlowBlendMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentFogMode, RenderingServer::EnvironmentFogMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentToneMapper, RenderingServer::EnvironmentToneMapper);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSSRRoughnessQuality, RenderingServer::EnvironmentSSRRoughnessQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSSAOQuality, RenderingServer::EnvironmentSSAOQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSSILQuality, RenderingServer::EnvironmentSSILQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSDFGIFramesToConverge, RenderingServer::EnvironmentSDFGIFramesToConverge);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSDFGIRayCount, RenderingServer::EnvironmentSDFGIRayCount);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSDFGIFramesToUpdateLight, RenderingServer::EnvironmentSDFGIFramesToUpdateLight);
|
|
VARIANT_ENUM_CAST_EXT(RSE::EnvironmentSDFGIYScale, RenderingServer::EnvironmentSDFGIYScale);
|
|
VARIANT_ENUM_CAST_EXT(RSE::SubSurfaceScatteringQuality, RenderingServer::SubSurfaceScatteringQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::DOFBlurQuality, RenderingServer::DOFBlurQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::DOFBokehShape, RenderingServer::DOFBokehShape);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ShadowQuality, RenderingServer::ShadowQuality);
|
|
VARIANT_ENUM_CAST_EXT(RSE::InstanceType, RenderingServer::InstanceType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::InstanceFlags, RenderingServer::InstanceFlags);
|
|
VARIANT_ENUM_CAST_EXT(RSE::ShadowCastingSetting, RenderingServer::ShadowCastingSetting);
|
|
VARIANT_ENUM_CAST_EXT(RSE::VisibilityRangeFadeMode, RenderingServer::VisibilityRangeFadeMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::NinePatchAxisMode, RenderingServer::NinePatchAxisMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasItemTextureFilter, RenderingServer::CanvasItemTextureFilter);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasItemTextureRepeat, RenderingServer::CanvasItemTextureRepeat);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasGroupMode, RenderingServer::CanvasGroupMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasLightMode, RenderingServer::CanvasLightMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasLightBlendMode, RenderingServer::CanvasLightBlendMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasLightShadowFilter, RenderingServer::CanvasLightShadowFilter);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasOccluderPolygonCullMode, RenderingServer::CanvasOccluderPolygonCullMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::GlobalShaderParameterType, RenderingServer::GlobalShaderParameterType);
|
|
VARIANT_ENUM_CAST_EXT(RSE::RenderingInfo, RenderingServer::RenderingInfo);
|
|
VARIANT_ENUM_CAST_EXT(RSE::SplashStretchMode, RenderingServer::SplashStretchMode);
|
|
VARIANT_ENUM_CAST_EXT(RSE::CanvasTextureChannel, RenderingServer::CanvasTextureChannel);
|
|
VARIANT_ENUM_CAST_EXT(RSE::BakeChannels, RenderingServer::BakeChannels);
|
|
|
|
#ifndef DISABLE_DEPRECATED
|
|
VARIANT_ENUM_CAST_EXT(RSE::Features, RenderingServer::Features);
|
|
#endif
|
|
|
|
// Alias to make it easier to use.
|
|
#define RS RenderingServer
|