RenderingServer
Inherits: Object
Server for anything visible.
Description
The rendering server is the API backend for everything visible. The whole scene system mounts on it to display. The rendering server is completely opaque: the internals are entirely implementation-specific and cannot be accessed.
The rendering server can be used to bypass the scene/Node system entirely. This can improve performance in cases where the scene system is the bottleneck, but won't improve performance otherwise (for instance, if the GPU is already fully utilized).
Resources are created using the *_create functions. These functions return RIDs which are not references to the objects themselves, but opaque pointers towards these objects.
All objects are drawn to a viewport. You can use the Viewport attached to the SceneTree or you can create one yourself with viewport_create(). When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using viewport_set_scenario() or viewport_attach_canvas().
Scenarios: In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the rendering server from a running game, the scenario can be accessed from the scene tree from any Node3D node with Node3D.get_world_3d(). Otherwise, a scenario can be created with scenario_create().
Similarly, in 2D, a canvas is needed to draw all canvas items.
3D: In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using instance_set_base(). The instance must also be attached to the scenario using instance_set_scenario() in order to be visible. RenderingServer methods that don't have a prefix are usually 3D-specific (but not always).
2D: In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas. 2D-specific RenderingServer methods generally start with canvas_*.
Headless mode: Starting the engine with the --headless command line argument disables all rendering and window management functions. Most functions from RenderingServer will return dummy values in this case.
Tutorials
Properties
Methods
Signals
frame_post_draw() 🔗
Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
frame_pre_draw() 🔗
Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
Enumerations
enum TextureType: 🔗
TextureType TEXTURE_TYPE_2D = 0
2D texture.
TextureType TEXTURE_TYPE_LAYERED = 1
Layered texture.
TextureType TEXTURE_TYPE_3D = 2
3D texture.
enum TextureLayeredType: 🔗
TextureLayeredType TEXTURE_LAYERED_2D_ARRAY = 0
Array of 2-dimensional textures (see Texture2DArray).
TextureLayeredType TEXTURE_LAYERED_CUBEMAP = 1
Cubemap texture (see Cubemap).
TextureLayeredType TEXTURE_LAYERED_CUBEMAP_ARRAY = 2
Array of cubemap textures (see CubemapArray).
enum CubeMapLayer: 🔗
CubeMapLayer CUBEMAP_LAYER_LEFT = 0
Left face of a Cubemap.
CubeMapLayer CUBEMAP_LAYER_RIGHT = 1
Right face of a Cubemap.
CubeMapLayer CUBEMAP_LAYER_BOTTOM = 2
Bottom face of a Cubemap.
CubeMapLayer CUBEMAP_LAYER_TOP = 3
Top face of a Cubemap.
CubeMapLayer CUBEMAP_LAYER_FRONT = 4
Front face of a Cubemap.
CubeMapLayer CUBEMAP_LAYER_BACK = 5
Back face of a Cubemap.
enum TextureDrawableFormat: 🔗
TextureDrawableFormat TEXTURE_DRAWABLE_FORMAT_RGBA8 = 0
OpenGL texture format RGBA with four components, each with a bitdepth of 8.
TextureDrawableFormat TEXTURE_DRAWABLE_FORMAT_RGBA8_SRGB = 1
OpenGL texture format RGBA with four components, each with a bitdepth of 8.
When drawn to, an sRGB to linear color space conversion is performed.
TextureDrawableFormat TEXTURE_DRAWABLE_FORMAT_RGBAH = 2
OpenGL texture format GL_RGBA16F where there are four components, each a 16-bit "half-precision" floating-point value.
TextureDrawableFormat TEXTURE_DRAWABLE_FORMAT_RGBAF = 3
OpenGL texture format GL_RGBA32F where there are four components, each a 32-bit floating-point value.
enum ShaderMode: 🔗
ShaderMode SHADER_SPATIAL = 0
Shader is a 3D shader.
ShaderMode SHADER_CANVAS_ITEM = 1
Shader is a 2D shader.
ShaderMode SHADER_PARTICLES = 2
Shader is a particle shader (can be used in both 2D and 3D).
ShaderMode SHADER_SKY = 3
Shader is a 3D sky shader.
ShaderMode SHADER_FOG = 4
Shader is a 3D fog shader.
ShaderMode SHADER_TEXTURE_BLIT = 5
Shader is a texture_blit shader.
ShaderMode SHADER_MAX = 6
Represents the size of the ShaderMode enum.
enum ArrayType: 🔗
ArrayType ARRAY_VERTEX = 0
Array is a vertex position array.
ArrayType ARRAY_NORMAL = 1
Array is a normal array.
ArrayType ARRAY_TANGENT = 2
Array is a tangent array.
ArrayType ARRAY_COLOR = 3
Array is a vertex color array.
ArrayType ARRAY_TEX_UV = 4
Array is a UV coordinates array.
ArrayType ARRAY_TEX_UV2 = 5
Array is a UV coordinates array for the second set of UV coordinates.
ArrayType ARRAY_CUSTOM0 = 6
Array is a custom data array for the first set of custom data.
ArrayType ARRAY_CUSTOM1 = 7
Array is a custom data array for the second set of custom data.
ArrayType ARRAY_CUSTOM2 = 8
Array is a custom data array for the third set of custom data.
ArrayType ARRAY_CUSTOM3 = 9
Array is a custom data array for the fourth set of custom data.
ArrayType ARRAY_BONES = 10
Array contains bone information.
ArrayType ARRAY_WEIGHTS = 11
Array is weight information.
ArrayType ARRAY_INDEX = 12
Array is an index array.
ArrayType ARRAY_MAX = 13
Represents the size of the ArrayType enum.
enum ArrayCustomFormat: 🔗
ArrayCustomFormat ARRAY_CUSTOM_RGBA8_UNORM = 0
Custom data array contains 8-bit-per-channel red/green/blue/alpha color data. Values are normalized, unsigned floating-point in the [0.0, 1.0] range.
ArrayCustomFormat ARRAY_CUSTOM_RGBA8_SNORM = 1
Custom data array contains 8-bit-per-channel red/green/blue/alpha color data. Values are normalized, signed floating-point in the [-1.0, 1.0] range.
ArrayCustomFormat ARRAY_CUSTOM_RG_HALF = 2
Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
ArrayCustomFormat ARRAY_CUSTOM_RGBA_HALF = 3
Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
ArrayCustomFormat ARRAY_CUSTOM_R_FLOAT = 4
Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
ArrayCustomFormat ARRAY_CUSTOM_RG_FLOAT = 5
Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
ArrayCustomFormat ARRAY_CUSTOM_RGB_FLOAT = 6
Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
ArrayCustomFormat ARRAY_CUSTOM_RGBA_FLOAT = 7
Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
ArrayCustomFormat ARRAY_CUSTOM_MAX = 8
Represents the size of the ArrayCustomFormat enum.
flags ArrayFormat: 🔗
ArrayFormat ARRAY_FORMAT_VERTEX = 1
Flag used to mark a vertex position array.
ArrayFormat ARRAY_FORMAT_NORMAL = 2
Flag used to mark a normal array.
ArrayFormat ARRAY_FORMAT_TANGENT = 4
Flag used to mark a tangent array.
ArrayFormat ARRAY_FORMAT_COLOR = 8
Flag used to mark a vertex color array.
ArrayFormat ARRAY_FORMAT_TEX_UV = 16
Flag used to mark a UV coordinates array.
ArrayFormat ARRAY_FORMAT_TEX_UV2 = 32
Flag used to mark a UV coordinates array for the second UV coordinates.
ArrayFormat ARRAY_FORMAT_CUSTOM0 = 64
Flag used to mark an array of custom per-vertex data for the first set of custom data.
ArrayFormat ARRAY_FORMAT_CUSTOM1 = 128
Flag used to mark an array of custom per-vertex data for the second set of custom data.
ArrayFormat ARRAY_FORMAT_CUSTOM2 = 256
Flag used to mark an array of custom per-vertex data for the third set of custom data.
ArrayFormat ARRAY_FORMAT_CUSTOM3 = 512
Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
ArrayFormat ARRAY_FORMAT_BONES = 1024
Flag used to mark a bone information array.
ArrayFormat ARRAY_FORMAT_WEIGHTS = 2048
Flag used to mark a weights array.
ArrayFormat ARRAY_FORMAT_INDEX = 4096
Flag used to mark an index array.
ArrayFormat ARRAY_FORMAT_BLEND_SHAPE_MASK = 7
Mask of mesh channels permitted in blend shapes.
ArrayFormat ARRAY_FORMAT_CUSTOM_BASE = 13
Shift of first custom channel.
ArrayFormat ARRAY_FORMAT_CUSTOM_BITS = 3
Number of format bits per custom channel. See ArrayCustomFormat.
ArrayFormat ARRAY_FORMAT_CUSTOM0_SHIFT = 13
Amount to shift ArrayCustomFormat for custom channel index 0.
ArrayFormat ARRAY_FORMAT_CUSTOM1_SHIFT = 16
Amount to shift ArrayCustomFormat for custom channel index 1.
ArrayFormat ARRAY_FORMAT_CUSTOM2_SHIFT = 19
Amount to shift ArrayCustomFormat for custom channel index 2.
ArrayFormat ARRAY_FORMAT_CUSTOM3_SHIFT = 22
Amount to shift ArrayCustomFormat for custom channel index 3.
ArrayFormat ARRAY_FORMAT_CUSTOM_MASK = 7
Mask of custom format bits per custom channel. Must be shifted by one of the SHIFT constants. See ArrayCustomFormat.
ArrayFormat ARRAY_COMPRESS_FLAGS_BASE = 25
Shift of first compress flag. Compress flags should be passed to ArrayMesh.add_surface_from_arrays() and SurfaceTool.commit().
ArrayFormat ARRAY_FLAG_USE_2D_VERTICES = 33554432
Flag used to mark that the array contains 2D vertices.
ArrayFormat ARRAY_FLAG_USE_DYNAMIC_UPDATE = 67108864
Flag used to mark that the mesh data will use GL_DYNAMIC_DRAW on GLES. Unused on Vulkan.
ArrayFormat ARRAY_FLAG_USE_8_BONE_WEIGHTS = 134217728
Flag used to mark that the array uses 8 bone weights instead of 4.
ArrayFormat ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 268435456
Flag used to mark that the mesh does not have a vertex array and instead will infer vertex positions in the shader using indices and other information.
ArrayFormat ARRAY_FLAG_COMPRESS_ATTRIBUTES = 536870912
Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can.
ArrayFormat ARRAY_FLAG_FORMAT_VERSION_BASE = 35
Flag used to mark the start of the bits used to store the mesh version.
ArrayFormat ARRAY_FLAG_FORMAT_VERSION_SHIFT = 35
Flag used to shift a mesh format int to bring the version into the lowest digits.
ArrayFormat ARRAY_FLAG_FORMAT_VERSION_1 = 0
Flag used to record the format used by prior mesh versions before the introduction of a version.
ArrayFormat ARRAY_FLAG_FORMAT_VERSION_2 = 34359738368
Flag used to record the second iteration of the mesh version flag. The primary difference between this and ARRAY_FLAG_FORMAT_VERSION_1 is that this version supports ARRAY_FLAG_COMPRESS_ATTRIBUTES and in this version vertex positions are de-interleaved from normals and tangents.
ArrayFormat ARRAY_FLAG_FORMAT_CURRENT_VERSION = 34359738368
Flag used to record the current version that the engine expects. Currently this is the same as ARRAY_FLAG_FORMAT_VERSION_2.
ArrayFormat ARRAY_FLAG_FORMAT_VERSION_MASK = 255
Flag used to isolate the bits used for mesh version after using ARRAY_FLAG_FORMAT_VERSION_SHIFT to shift them into place.
enum PrimitiveType: 🔗
PrimitiveType PRIMITIVE_POINTS = 0
Primitive to draw consists of points.
PrimitiveType PRIMITIVE_LINES = 1
Primitive to draw consists of lines.
PrimitiveType PRIMITIVE_LINE_STRIP = 2
Primitive to draw consists of a line strip from start to end.
PrimitiveType PRIMITIVE_TRIANGLES = 3
Primitive to draw consists of triangles.
PrimitiveType PRIMITIVE_TRIANGLE_STRIP = 4
Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
PrimitiveType PRIMITIVE_MAX = 5
Represents the size of the PrimitiveType enum.
enum BlendShapeMode: 🔗
BlendShapeMode BLEND_SHAPE_MODE_NORMALIZED = 0
Blend shapes are normalized.
BlendShapeMode BLEND_SHAPE_MODE_RELATIVE = 1
Blend shapes are relative to base weight.
enum MultimeshTransformFormat: 🔗
MultimeshTransformFormat MULTIMESH_TRANSFORM_2D = 0
Use Transform2D to store MultiMesh transform.
MultimeshTransformFormat MULTIMESH_TRANSFORM_3D = 1
Use Transform3D to store MultiMesh transform.
enum MultimeshPhysicsInterpolationQuality: 🔗
MultimeshPhysicsInterpolationQuality MULTIMESH_INTERP_QUALITY_FAST = 0
MultiMesh physics interpolation favors speed over quality.
MultimeshPhysicsInterpolationQuality MULTIMESH_INTERP_QUALITY_HIGH = 1
MultiMesh physics interpolation favors quality over speed.
enum LightProjectorFilter: 🔗
LightProjectorFilter LIGHT_PROJECTOR_FILTER_NEAREST = 0
Nearest-neighbor filter for light projectors (use for pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
LightProjectorFilter LIGHT_PROJECTOR_FILTER_LINEAR = 1
Linear filter for light projectors (use for non-pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
LightProjectorFilter LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS = 2
Nearest-neighbor filter for light projectors (use for pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
LightProjectorFilter LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS = 3
Linear filter for light projectors (use for non-pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
LightProjectorFilter LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC = 4
Nearest-neighbor filter for light projectors (use for pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.
LightProjectorFilter LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC = 5
Linear filter for light projectors (use for non-pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.
enum LightType: 🔗
LightType LIGHT_DIRECTIONAL = 0
Directional (sun/moon) light (see DirectionalLight3D).
LightType LIGHT_OMNI = 1
Omni light (see OmniLight3D).
LightType LIGHT_SPOT = 2
Spot light (see SpotLight3D).
LightType LIGHT_AREA = 3
Area light (see AreaLight3D).
enum LightParam: 🔗
LightParam LIGHT_PARAM_ENERGY = 0
The light's energy multiplier.
LightParam LIGHT_PARAM_INDIRECT_ENERGY = 1
The light's indirect energy multiplier (final indirect energy is LIGHT_PARAM_ENERGY * LIGHT_PARAM_INDIRECT_ENERGY).
LightParam LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY = 2
The light's volumetric fog energy multiplier (final volumetric fog energy is LIGHT_PARAM_ENERGY * LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY).
LightParam LIGHT_PARAM_SPECULAR = 3
The light's influence on specularity.
LightParam LIGHT_PARAM_RANGE = 4
The light's range.
LightParam LIGHT_PARAM_SIZE = 5
The size of the light when using spot light or omni light. The angular size of the light when using directional light.
LightParam LIGHT_PARAM_ATTENUATION = 6
The light's attenuation.
LightParam LIGHT_PARAM_SPOT_ANGLE = 7
The spotlight's angle.
LightParam LIGHT_PARAM_SPOT_ATTENUATION = 8
The spotlight's attenuation.
LightParam LIGHT_PARAM_SHADOW_MAX_DISTANCE = 9
The maximum distance for shadow splits. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (since more objects need to be included in the directional shadow rendering).
LightParam LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET = 10
Proportion of shadow atlas occupied by the first split.
LightParam LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET = 11
Proportion of shadow atlas occupied by the second split.
LightParam LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET = 12
Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
LightParam LIGHT_PARAM_SHADOW_FADE_START = 13
Proportion of shadow max distance where the shadow will start to fade out.
LightParam LIGHT_PARAM_SHADOW_NORMAL_BIAS = 14
Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
LightParam LIGHT_PARAM_SHADOW_BIAS = 15
Bias for the shadow lookup to fix self-shadowing artifacts.
LightParam LIGHT_PARAM_SHADOW_PANCAKE_SIZE = 16
Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to 0 turns off the pancaking effect.
LightParam LIGHT_PARAM_SHADOW_OPACITY = 17
The light's shadow opacity. Values lower than 1.0 make the light appear through shadows. This can be used to fake global illumination at a low performance cost.
LightParam LIGHT_PARAM_SHADOW_BLUR = 18
Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolution shadow maps. A high value can make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.
LightParam LIGHT_PARAM_TRANSMITTANCE_BIAS = 19
There is currently no description for this enum. Please help us by contributing one!
LightParam LIGHT_PARAM_INTENSITY = 20
Constant representing the intensity of the light, measured in Lumens when dealing with a SpotLight3D or OmniLight3D, or measured in Lux with a DirectionalLight3D. Only used when ProjectSettings.rendering/lights_and_shadows/use_physical_light_units is true.
LightParam LIGHT_PARAM_MAX = 21
Represents the size of the LightParam enum.
enum LightBakeMode: 🔗
LightBakeMode LIGHT_BAKE_DISABLED = 0
Light is ignored when baking. This is the fastest mode, but the light will be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights.
LightBakeMode LIGHT_BAKE_STATIC = 1
Light is taken into account in static baking (VoxelGI, LightmapGI, SDFGI (Environment.sdfgi_enabled)). The light can be moved around or modified, but its global illumination will not update in real-time. This is suitable for subtle changes (such as flickering torches), but generally not large changes such as toggling a light on and off.
LightBakeMode LIGHT_BAKE_DYNAMIC = 2
Light is taken into account in dynamic baking (VoxelGI and SDFGI (Environment.sdfgi_enabled) only). The light can be moved around or modified with global illumination updating in real-time. The light's global illumination appearance will be slightly different compared to LIGHT_BAKE_STATIC. This has a greater performance cost compared to LIGHT_BAKE_STATIC. When using SDFGI, the update speed of dynamic lights is affected by ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights.
enum LightOmniShadowMode: 🔗
LightOmniShadowMode LIGHT_OMNI_SHADOW_DUAL_PARABOLOID = 0
Use a dual paraboloid shadow map for omni lights.
LightOmniShadowMode LIGHT_OMNI_SHADOW_CUBE = 1
Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
enum LightDirectionalShadowMode: 🔗
LightDirectionalShadowMode LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL = 0
Use orthogonal shadow projection for directional light.
LightDirectionalShadowMode LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS = 1
Use 2 splits for shadow projection when using directional light.
LightDirectionalShadowMode LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS = 2
Use 4 splits for shadow projection when using directional light.
enum LightDirectionalSkyMode: 🔗
LightDirectionalSkyMode LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY = 0
Use DirectionalLight3D in both sky rendering and scene lighting.
LightDirectionalSkyMode LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY = 1
Only use DirectionalLight3D in scene lighting.
LightDirectionalSkyMode LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY = 2
Only use DirectionalLight3D in sky rendering.
enum ShadowQuality: 🔗
ShadowQuality SHADOW_QUALITY_HARD = 0
Lowest shadow filtering quality (fastest). Soft shadows are not available with this quality setting, which means the Light3D.shadow_blur property is ignored if Light3D.light_size and Light3D.light_angular_distance is 0.0.
Note: The variable shadow blur performed by Light3D.light_size and Light3D.light_angular_distance is still effective when using hard shadow filtering. In this case, Light3D.shadow_blur is taken into account. However, the results will not be blurred, instead the blur amount is treated as a maximum radius for the penumbra.
ShadowQuality SHADOW_QUALITY_SOFT_VERY_LOW = 1
Very low shadow filtering quality (faster). When using this quality setting, Light3D.shadow_blur is automatically multiplied by 0.75× to avoid introducing too much noise. This division only applies to lights whose Light3D.light_size or Light3D.light_angular_distance is 0.0).
ShadowQuality SHADOW_QUALITY_SOFT_LOW = 2
Low shadow filtering quality (fast).
ShadowQuality SHADOW_QUALITY_SOFT_MEDIUM = 3
Medium low shadow filtering quality (average).
ShadowQuality SHADOW_QUALITY_SOFT_HIGH = 4
High low shadow filtering quality (slow). When using this quality setting, Light3D.shadow_blur is automatically multiplied by 1.5× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose Light3D.light_size or Light3D.light_angular_distance is 0.0).
ShadowQuality SHADOW_QUALITY_SOFT_ULTRA = 5
Highest low shadow filtering quality (slowest). When using this quality setting, Light3D.shadow_blur is automatically multiplied by 2× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose Light3D.light_size or Light3D.light_angular_distance is 0.0).
ShadowQuality SHADOW_QUALITY_MAX = 6
Represents the size of the ShadowQuality enum.
enum ReflectionProbeUpdateMode: 🔗
ReflectionProbeUpdateMode REFLECTION_PROBE_UPDATE_ONCE = 0
Reflection probe will update reflections once and then stop.
ReflectionProbeUpdateMode REFLECTION_PROBE_UPDATE_ALWAYS = 1
Reflection probe will update each frame. This mode is necessary to capture moving objects.
enum ReflectionProbeAmbientMode: 🔗
ReflectionProbeAmbientMode REFLECTION_PROBE_AMBIENT_DISABLED = 0
Do not apply any ambient lighting inside the reflection probe's box defined by its size.
ReflectionProbeAmbientMode REFLECTION_PROBE_AMBIENT_ENVIRONMENT = 1
Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
ReflectionProbeAmbientMode REFLECTION_PROBE_AMBIENT_COLOR = 2
Apply custom ambient lighting inside the reflection probe's box defined by its size. See reflection_probe_set_ambient_color() and reflection_probe_set_ambient_energy().
enum DecalTexture: 🔗
DecalTexture DECAL_TEXTURE_ALBEDO = 0
Albedo texture slot in a decal (Decal.texture_albedo).
DecalTexture DECAL_TEXTURE_NORMAL = 1
Normal map texture slot in a decal (Decal.texture_normal).
DecalTexture DECAL_TEXTURE_ORM = 2
Occlusion/Roughness/Metallic texture slot in a decal (Decal.texture_orm).
DecalTexture DECAL_TEXTURE_EMISSION = 3
Emission texture slot in a decal (Decal.texture_emission).
DecalTexture DECAL_TEXTURE_MAX = 4
Represents the size of the DecalTexture enum.
enum DecalFilter: 🔗
DecalFilter DECAL_FILTER_NEAREST = 0
Nearest-neighbor filter for decals (use for pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
DecalFilter DECAL_FILTER_LINEAR = 1
Linear filter for decals (use for non-pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
DecalFilter DECAL_FILTER_NEAREST_MIPMAPS = 2
Nearest-neighbor filter for decals (use for pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
DecalFilter DECAL_FILTER_LINEAR_MIPMAPS = 3
Linear filter for decals (use for non-pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
DecalFilter DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC = 4
Nearest-neighbor filter for decals (use for pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.
DecalFilter DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC = 5
Linear filter for decals (use for non-pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.
enum VoxelGIQuality: 🔗
VoxelGIQuality VOXEL_GI_QUALITY_LOW = 0
Low VoxelGI rendering quality using 4 cones.
VoxelGIQuality VOXEL_GI_QUALITY_HIGH = 1
High VoxelGI rendering quality using 6 cones.
enum ParticlesMode: 🔗
ParticlesMode PARTICLES_MODE_2D = 0
2D particles.
ParticlesMode PARTICLES_MODE_3D = 1
3D particles.
enum ParticlesTransformAlign: 🔗
ParticlesTransformAlign PARTICLES_TRANSFORM_ALIGN_DISABLED = 0
Do not align particle transforms relative to the camera or velocity.
ParticlesTransformAlign PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD = 1
Align each particle's Z axis to face the camera.
ParticlesTransformAlign PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY = 2
Align each particle's Y axis to the velocity vector.
ParticlesTransformAlign PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY = 3
Align each particle's Z axis to face the camera and Y axis to the velocity vector.
ParticlesTransformAlign PARTICLES_TRANSFORM_ALIGN_LOCAL_BILLBOARD = 4
Billboard each particles around a local axis.
enum ParticlesTransformAlignCustomSrc: 🔗
ParticlesTransformAlignCustomSrc PARTICLES_ALIGN_CHANNEL_FILTER_DISABLED = 0
Do not read from CUSTOM when performing billboarding.
ParticlesTransformAlignCustomSrc PARTICLES_ALIGN_CHANNEL_FILTER_X = 1
Read from CUSTOM.x when performing billboarding and use it as an angle, in radians.
ParticlesTransformAlignCustomSrc PARTICLES_ALIGN_CHANNEL_FILTER_Y = 2
Read from CUSTOM.y when performing billboarding and use it as an angle, in radians.
ParticlesTransformAlignCustomSrc PARTICLES_ALIGN_CHANNEL_FILTER_Z = 3
Read from CUSTOM.z when performing billboarding and use it as an angle, in radians.
ParticlesTransformAlignCustomSrc PARTICLES_ALIGN_CHANNEL_FILTER_W = 4
Read from CUSTOM.w when performing billboarding and use it as an angle, in radians.
enum ParticlesTransformAlignAxis: 🔗
ParticlesTransformAlignAxis PARTICLES_ALIGN_AXIS_X = 0
Use the X axis for local billboarding.
ParticlesTransformAlignAxis PARTICLES_ALIGN_AXIS_Y = 1
Use the Y axis for local billboarding.
enum ParticlesDrawOrder: 🔗
ParticlesDrawOrder PARTICLES_DRAW_ORDER_INDEX = 0
Draw particles in the order that they appear in the particles array.
ParticlesDrawOrder PARTICLES_DRAW_ORDER_LIFETIME = 1
Sort particles based on their lifetime. In other words, the particle with the highest lifetime is drawn at the front.
ParticlesDrawOrder PARTICLES_DRAW_ORDER_REVERSE_LIFETIME = 2
Sort particles based on the inverse of their lifetime. In other words, the particle with the lowest lifetime is drawn at the front.
ParticlesDrawOrder PARTICLES_DRAW_ORDER_VIEW_DEPTH = 3
Sort particles based on their distance to the camera.
enum ParticlesCollisionType: 🔗
ParticlesCollisionType PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT = 0
Sphere attractor type for GPUParticles3D (see GPUParticlesAttractorSphere3D).
ParticlesCollisionType PARTICLES_COLLISION_TYPE_BOX_ATTRACT = 1
Box attractor type for GPUParticles3D (see GPUParticlesAttractorBox3D).
ParticlesCollisionType PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT = 2
Vector field attractor type for GPUParticles3D (see GPUParticlesAttractorVectorField3D).
ParticlesCollisionType PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE = 3
Sphere collision type for GPUParticles3D (see GPUParticlesCollisionSphere3D).
ParticlesCollisionType PARTICLES_COLLISION_TYPE_BOX_COLLIDE = 4
Box collision type for GPUParticles3D (see GPUParticlesCollisionBox3D).
ParticlesCollisionType PARTICLES_COLLISION_TYPE_SDF_COLLIDE = 5
Signed distance field collision type for GPUParticles3D (see GPUParticlesCollisionSDF3D).
ParticlesCollisionType PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE = 6
Heightfield collision type for GPUParticles3D (see GPUParticlesCollisionHeightField3D).
enum ParticlesCollisionHeightfieldResolution: 🔗
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256 = 0
256×256 heightfield resolution for GPUParticlesCollisionHeightField3D.
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512 = 1
512×512 heightfield resolution for GPUParticlesCollisionHeightField3D.
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024 = 2
1024×1024 heightfield resolution for GPUParticlesCollisionHeightField3D.
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048 = 3
2048×2048 heightfield resolution for GPUParticlesCollisionHeightField3D.
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096 = 4
4096×4096 heightfield resolution for GPUParticlesCollisionHeightField3D.
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192 = 5
8192×8192 heightfield resolution for GPUParticlesCollisionHeightField3D.
ParticlesCollisionHeightfieldResolution PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX = 6
Represents the size of the ParticlesCollisionHeightfieldResolution enum.
enum FogVolumeShape: 🔗
FogVolumeShape FOG_VOLUME_SHAPE_ELLIPSOID = 0
FogVolume will be shaped like an ellipsoid (stretched sphere).
FogVolumeShape FOG_VOLUME_SHAPE_CONE = 1
FogVolume will be shaped like a cone pointing upwards (in local coordinates). The cone's angle is set automatically to fill the size. The cone will be adjusted to fit within the size. Rotate the FogVolume node to reorient the cone. Non-uniform scaling via size is not supported (scale the FogVolume node instead).
FogVolumeShape FOG_VOLUME_SHAPE_CYLINDER = 2
FogVolume will be shaped like an upright cylinder (in local coordinates). Rotate the FogVolume node to reorient the cylinder. The cylinder will be adjusted to fit within the size. Non-uniform scaling via size is not supported (scale the FogVolume node instead).
FogVolumeShape FOG_VOLUME_SHAPE_BOX = 3
FogVolume will be shaped like a box.
FogVolumeShape FOG_VOLUME_SHAPE_WORLD = 4
FogVolume will have no shape, will cover the whole world and will not be culled.
FogVolumeShape FOG_VOLUME_SHAPE_MAX = 5
Represents the size of the FogVolumeShape enum.
enum ViewportScaling3DMode: 🔗
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_BILINEAR = 0
Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using Viewport.scaling_3d_scale. Values less than 1.0 will result in undersampling while values greater than 1.0 will result in supersampling. A value of 1.0 disables scaling.
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_FSR = 1
Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using Viewport.scaling_3d_scale. Values less than 1.0 will result in the viewport being upscaled using FSR. Values greater than 1.0 are not supported and bilinear downsampling will be used instead. A value of 1.0 disables scaling.
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_FSR2 = 2
Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using Viewport.scaling_3d_scale. Values less than 1.0 will result in the viewport being upscaled using FSR2. Values greater than 1.0 are not supported and bilinear downsampling will be used instead. A value of 1.0 will use FSR2 at native resolution as a TAA solution.
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL = 3
Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using Viewport.scaling_3d_scale. Values less than 1.0 will result in the viewport being upscaled using MetalFX. Values greater than 1.0 are not supported and bilinear downsampling will be used instead. A value of 1.0 disables scaling.
Note: Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL = 4
Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using Viewport.scaling_3d_scale. Values less than 1.0 will result in the viewport being upscaled using MetalFX. Values greater than 1.0 are not supported and bilinear downsampling will be used instead. A value of 1.0 will use MetalFX at native resolution as a TAA solution.
Note: Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_NEAREST = 5
Use nearest-neighbor filtering for the viewport's 3D buffer. This looks crisper than VIEWPORT_SCALING_3D_MODE_BILINEAR and has no additional rendering cost. The amount of scaling can be set using Viewport.scaling_3d_scale. Values greater than 1.0 are not supported and bilinear downsampling will be used instead. A value of 1.0 disables scaling.
Note: When using the Nearest scaling mode, to avoid uneven pixel scaling, it's highly recommended to use a value equal to an integer divisor with a dividend of 1. For example, it's best to use a scale of 0.5 (1/2), 0.3333 (1/3), 0.25 (1/4), 0.2 (1/5), and so on.
ViewportScaling3DMode VIEWPORT_SCALING_3D_MODE_MAX = 6
Represents the size of the ViewportScaling3DMode enum.
enum ViewportUpdateMode: 🔗
ViewportUpdateMode VIEWPORT_UPDATE_DISABLED = 0
Do not update the viewport's render target.
ViewportUpdateMode VIEWPORT_UPDATE_ONCE = 1
Update the viewport's render target once, then switch to VIEWPORT_UPDATE_DISABLED.
ViewportUpdateMode VIEWPORT_UPDATE_WHEN_VISIBLE = 2
Update the viewport's render target only when it is visible. This is the default value.
ViewportUpdateMode VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE = 3
Update the viewport's render target only when its parent is visible.
ViewportUpdateMode VIEWPORT_UPDATE_ALWAYS = 4
Always update the viewport's render target.
enum ViewportClearMode: 🔗
ViewportClearMode VIEWPORT_CLEAR_ALWAYS = 0
Always clear the viewport's render target before drawing.
ViewportClearMode VIEWPORT_CLEAR_NEVER = 1
Never clear the viewport's render target.
ViewportClearMode VIEWPORT_CLEAR_ONLY_NEXT_FRAME = 2
Clear the viewport's render target on the next frame, then switch to VIEWPORT_CLEAR_NEVER.
enum ViewportEnvironmentMode: 🔗
ViewportEnvironmentMode VIEWPORT_ENVIRONMENT_DISABLED = 0
Disable rendering of 3D environment over 2D canvas.
ViewportEnvironmentMode VIEWPORT_ENVIRONMENT_ENABLED = 1
Enable rendering of 3D environment over 2D canvas.
ViewportEnvironmentMode VIEWPORT_ENVIRONMENT_INHERIT = 2
Inherit enable/disable value from parent. If the topmost parent is also set to VIEWPORT_ENVIRONMENT_INHERIT, then this has the same behavior as VIEWPORT_ENVIRONMENT_ENABLED.
ViewportEnvironmentMode VIEWPORT_ENVIRONMENT_MAX = 3
Represents the size of the ViewportEnvironmentMode enum.
enum ViewportSDFOversize: 🔗
ViewportSDFOversize VIEWPORT_SDF_OVERSIZE_100_PERCENT = 0
Do not oversize the 2D signed distance field. Occluders may disappear when touching the viewport's edges, and GPUParticles3D collision may stop working earlier than intended. This has the lowest GPU requirements.
ViewportSDFOversize VIEWPORT_SDF_OVERSIZE_120_PERCENT = 1
2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
ViewportSDFOversize VIEWPORT_SDF_OVERSIZE_150_PERCENT = 2
2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
ViewportSDFOversize VIEWPORT_SDF_OVERSIZE_200_PERCENT = 3
2D signed distance field covers 100% of the viewport's size outside the viewport on each side (top, right, bottom, left). This has the highest GPU requirements.
ViewportSDFOversize VIEWPORT_SDF_OVERSIZE_MAX = 4
Represents the size of the ViewportSDFOversize enum.
enum ViewportSDFScale: 🔗
ViewportSDFScale VIEWPORT_SDF_SCALE_100_PERCENT = 0
Full resolution 2D signed distance field scale. This has the highest GPU requirements.
ViewportSDFScale VIEWPORT_SDF_SCALE_50_PERCENT = 1
Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
ViewportSDFScale VIEWPORT_SDF_SCALE_25_PERCENT = 2
Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
ViewportSDFScale VIEWPORT_SDF_SCALE_MAX = 3
Represents the size of the ViewportSDFScale enum.
enum ViewportMSAA: 🔗
ViewportMSAA VIEWPORT_MSAA_DISABLED = 0
Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
ViewportMSAA VIEWPORT_MSAA_2X = 1
Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
ViewportMSAA VIEWPORT_MSAA_4X = 2
Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
ViewportMSAA VIEWPORT_MSAA_8X = 3
Multisample antialiasing uses 8 samples per pixel for 3D. This has a very high impact on performance. Likely unsupported on low-end and older hardware.
ViewportMSAA VIEWPORT_MSAA_MAX = 4
Represents the size of the ViewportMSAA enum.
enum ViewportAnisotropicFiltering: 🔗
ViewportAnisotropicFiltering VIEWPORT_ANISOTROPY_DISABLED = 0
Anisotropic filtering is disabled.
ViewportAnisotropicFiltering VIEWPORT_ANISOTROPY_2X = 1
Use 2× anisotropic filtering.
ViewportAnisotropicFiltering VIEWPORT_ANISOTROPY_4X = 2
Use 4× anisotropic filtering. This is the default value.
ViewportAnisotropicFiltering VIEWPORT_ANISOTROPY_8X = 3
Use 8× anisotropic filtering.
ViewportAnisotropicFiltering VIEWPORT_ANISOTROPY_16X = 4
Use 16× anisotropic filtering.
ViewportAnisotropicFiltering VIEWPORT_ANISOTROPY_MAX = 5
Represents the size of the ViewportAnisotropicFiltering enum.
enum ViewportScreenSpaceAA: 🔗
ViewportScreenSpaceAA VIEWPORT_SCREEN_SPACE_AA_DISABLED = 0
Do not perform any antialiasing in the full screen post-process.
ViewportScreenSpaceAA VIEWPORT_SCREEN_SPACE_AA_FXAA = 1
Use fast approximate antialiasing. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K.
ViewportScreenSpaceAA VIEWPORT_SCREEN_SPACE_AA_SMAA = 2
Use subpixel morphological antialiasing. SMAA may produce clearer results than FXAA, but at a slightly higher performance cost.
ViewportScreenSpaceAA VIEWPORT_SCREEN_SPACE_AA_MAX = 3
Represents the size of the ViewportScreenSpaceAA enum.
enum ViewportOcclusionCullingBuildQuality: 🔗
ViewportOcclusionCullingBuildQuality VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW = 0
Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
ViewportOcclusionCullingBuildQuality VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM = 1
Medium occlusion culling BVH build quality (as defined by Embree).
ViewportOcclusionCullingBuildQuality VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH = 2
High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
enum ViewportRenderInfo: 🔗
ViewportRenderInfo VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME = 0
Number of objects drawn in a single frame.
ViewportRenderInfo VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME = 1
Number of points, lines, or triangles drawn in a single frame.
ViewportRenderInfo VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME = 2
Number of draw calls during this frame.
ViewportRenderInfo VIEWPORT_RENDER_INFO_MAX = 3
Represents the size of the ViewportRenderInfo enum.
enum ViewportRenderInfoType: 🔗
ViewportRenderInfoType VIEWPORT_RENDER_INFO_TYPE_VISIBLE = 0
Visible render pass (excluding shadows).
ViewportRenderInfoType VIEWPORT_RENDER_INFO_TYPE_SHADOW = 1
Shadow render pass. Objects will be rendered several times depending on the number of amounts of lights with shadows and the number of directional shadow splits.
ViewportRenderInfoType VIEWPORT_RENDER_INFO_TYPE_CANVAS = 2
Canvas item rendering. This includes all 2D rendering.
ViewportRenderInfoType VIEWPORT_RENDER_INFO_TYPE_MAX = 3
Represents the size of the ViewportRenderInfoType enum.
enum ViewportDebugDraw: 🔗
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_DISABLED = 0
Debug draw is disabled. Default setting.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_UNSHADED = 1
Objects are displayed without light information.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_LIGHTING = 2
Objects are displayed with only light information.
Note: When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_OVERDRAW = 3
Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw (represented by brighter colors) means you are wasting performance on drawing pixels that are being hidden behind others.
Note: When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_WIREFRAME = 4
Debug draw draws objects in wireframe.
Note: set_debug_generate_wireframes() must be called before loading any meshes for wireframes to be visible when using the Compatibility renderer.
Note: In the Compatibility renderer, backfaces are always visible when using wireframe rendering. In the Forward+ and Mobile renderers, wireframes follow the material's backface culling properties instead.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER = 5
Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO = 6
Objects are displayed with only the albedo value from VoxelGIs. Requires at least one visible VoxelGI node that has been baked to have a visible effect.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING = 7
Objects are displayed with only the lighting value from VoxelGIs. Requires at least one visible VoxelGI node that has been baked to have a visible effect.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION = 8
Objects are displayed with only the emission color from VoxelGIs. Requires at least one visible VoxelGI node that has been baked to have a visible effect.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS = 9
Draws the shadow atlas that stores shadows from OmniLight3Ds and SpotLight3Ds in the upper left quadrant of the Viewport.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS = 10
Draws the shadow atlas that stores shadows from DirectionalLight3Ds in the upper left quadrant of the Viewport.
The slice of the camera frustum related to the shadow map cascade is superimposed to visualize coverage. The color of each slice matches the colors used for VIEWPORT_DEBUG_DRAW_PSSM_SPLITS. When shadow cascades are blended the overlap is taken into account when drawing the frustum slices.
The last cascade shows all frustum slices to illustrate the coverage of all slices.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE = 11
Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
Note: Only supported when using the Forward+ or Mobile rendering methods.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_SSAO = 12
Draws the screen space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have Environment.ssao_enabled set in your WorldEnvironment.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_SSIL = 13
Draws the screen space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have Environment.ssil_enabled set in your WorldEnvironment.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_PSSM_SPLITS = 14
Colors each PSSM split for the DirectionalLight3Ds in the scene a different color so you can see where the splits are. In order (from closest to furthest from the camera), they are colored red, green, blue, and yellow.
Note: When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
Note: Only supported when using the Forward+ or Mobile rendering methods.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_DECAL_ATLAS = 15
Draws the decal atlas that stores decal textures from Decals.
Note: Only supported when using the Forward+ or Mobile rendering methods.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_SDFGI = 16
Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_SDFGI_PROBES = 17
Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
When in the editor, left-clicking a probe will display additional bright dots that show its occlusion information. A white dot means the light is not occluded at all at the dot's position, while a red dot means the light is fully occluded. Intermediate values are possible.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_GI_BUFFER = 18
Draws the global illumination buffer from VoxelGI or SDFGI. Requires VoxelGI (at least one visible baked VoxelGI node) or SDFGI (Environment.sdfgi_enabled) to be enabled to have a visible effect.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_DISABLE_LOD = 19
Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS = 20
Draws the OmniLight3D cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS = 21
Draws the SpotLight3D cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS = 22
Draws the Decal cluster. Clustering determines where decals are positioned in screen-space, which allows the engine to only process these portions of the screen for decals.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES = 23
Draws the ReflectionProbe cluster. Clustering determines where reflection probes are positioned in screen-space, which allows the engine to only process these portions of the screen for reflection probes.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_OCCLUDERS = 24
Draws the occlusion culling buffer. This low-resolution occlusion culling buffer is rasterized on the CPU and is used to check whether instances are occluded by other objects.
Note: Only supported when using the Forward+ or Mobile rendering methods.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_MOTION_VECTORS = 25
Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
Note: Only supported when using the Forward+ rendering method.
ViewportDebugDraw VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER = 26
Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects.
Note: Only supported when using the Forward+ or Mobile rendering methods.
enum ViewportVRSMode: 🔗
ViewportVRSMode VIEWPORT_VRS_DISABLED = 0
Variable rate shading is disabled.
ViewportVRSMode VIEWPORT_VRS_TEXTURE = 1
Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
ViewportVRSMode VIEWPORT_VRS_XR = 2
Variable rate shading texture is supplied by the primary XRInterface. Note that this may override the update mode.
ViewportVRSMode VIEWPORT_VRS_MAX = 3
Represents the size of the ViewportVRSMode enum.
enum ViewportVRSUpdateMode: 🔗
ViewportVRSUpdateMode VIEWPORT_VRS_UPDATE_DISABLED = 0
The input texture for variable rate shading will not be processed.
ViewportVRSUpdateMode VIEWPORT_VRS_UPDATE_ONCE = 1
The input texture for variable rate shading will be processed once.
ViewportVRSUpdateMode VIEWPORT_VRS_UPDATE_ALWAYS = 2
The input texture for variable rate shading will be processed each frame.
ViewportVRSUpdateMode VIEWPORT_VRS_UPDATE_MAX = 3
Represents the size of the ViewportVRSUpdateMode enum.
enum SkyMode: 🔗
SkyMode SKY_MODE_AUTOMATIC = 0
Automatically selects the appropriate process mode based on your sky shader. If your shader uses TIME or POSITION, this will use SKY_MODE_REALTIME. If your shader uses any of the LIGHT_* variables or any custom uniforms, this uses SKY_MODE_INCREMENTAL. Otherwise, this defaults to SKY_MODE_QUALITY.
SkyMode SKY_MODE_QUALITY = 1
Uses high quality importance sampling to process the radiance map. In general, this results in much higher quality than SKY_MODE_REALTIME but takes much longer to generate. This should not be used if you plan on changing the sky at runtime. If you are finding that the reflection is not blurry enough and is showing sparkles or fireflies, try increasing ProjectSettings.rendering/reflections/sky_reflections/ggx_samples.
SkyMode SKY_MODE_INCREMENTAL = 2
Uses the same high quality importance sampling to process the radiance map as SKY_MODE_QUALITY, but updates over several frames. The number of frames is determined by ProjectSettings.rendering/reflections/sky_reflections/roughness_layers. Use this when you need highest quality radiance maps, but have a sky that updates slowly.
SkyMode SKY_MODE_REALTIME = 3
Uses the fast filtering algorithm to process the radiance map. In general this results in lower quality, but substantially faster run times. If you need better quality, but still need to update the sky every frame, consider turning on ProjectSettings.rendering/reflections/sky_reflections/fast_filter_high_quality.
Note: The fast filtering algorithm is limited to 256×256 cubemaps, so sky_set_radiance_size() must be set to 256. Otherwise, a warning is printed and the overridden radiance size is ignored.
enum CompositorEffectFlags: 🔗
CompositorEffectFlags COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR = 1
The rendering effect requires the color buffer to be resolved if MSAA is enabled.
CompositorEffectFlags COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH = 2
The rendering effect requires the depth buffer to be resolved if MSAA is enabled.
CompositorEffectFlags COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS = 4
The rendering effect requires motion vectors to be produced.
CompositorEffectFlags COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS = 8
The rendering effect requires normals and roughness g-buffer to be produced (Forward+ only).
CompositorEffectFlags COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR = 16
The rendering effect requires specular data to be separated out (Forward+ only).
enum CompositorEffectCallbackType: 🔗
CompositorEffectCallbackType COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE = 0
The callback is called before our opaque rendering pass, but after depth prepass (if applicable).
CompositorEffectCallbackType COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE = 1
The callback is called after our opaque rendering pass, but before our sky is rendered.
CompositorEffectCallbackType COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY = 2
The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections).
CompositorEffectCallbackType COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT = 3
The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers.
CompositorEffectCallbackType COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT = 4
The callback is called after our transparent rendering pass, but before any built-in post-processing effects and output to our render target.
CompositorEffectCallbackType COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY = -1
There is currently no description for this enum. Please help us by contributing one!
enum EnvironmentBG: 🔗
EnvironmentBG ENV_BG_CLEAR_COLOR = 0
Use the clear color as background.
EnvironmentBG ENV_BG_COLOR = 1
Use a specified color as the background.
EnvironmentBG ENV_BG_SKY = 2
Use a sky resource for the background.
EnvironmentBG ENV_BG_CANVAS = 3
Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
EnvironmentBG ENV_BG_KEEP = 4
Do not clear the background, use whatever was rendered last frame as the background.
EnvironmentBG ENV_BG_CAMERA_FEED = 5
Displays a camera feed in the background.
EnvironmentBG ENV_BG_MAX = 6
Represents the size of the EnvironmentBG enum.
enum EnvironmentAmbientSource: 🔗
EnvironmentAmbientSource ENV_AMBIENT_SOURCE_BG = 0
Gather ambient light from whichever source is specified as the background.
EnvironmentAmbientSource ENV_AMBIENT_SOURCE_DISABLED = 1
Disable ambient light.
EnvironmentAmbientSource ENV_AMBIENT_SOURCE_COLOR = 2
Specify a specific Color for ambient light.
EnvironmentAmbientSource ENV_AMBIENT_SOURCE_SKY = 3
Gather ambient light from the Sky regardless of what the background is.
enum EnvironmentReflectionSource: 🔗
EnvironmentReflectionSource ENV_REFLECTION_SOURCE_BG = 0
Use the background for reflections.
EnvironmentReflectionSource ENV_REFLECTION_SOURCE_DISABLED = 1
Disable reflections.
EnvironmentReflectionSource ENV_REFLECTION_SOURCE_SKY = 2
Use the Sky for reflections regardless of what the background is.
enum EnvironmentGlowBlendMode: 🔗
EnvironmentGlowBlendMode ENV_GLOW_BLEND_MODE_ADDITIVE = 0
Adds the glow effect to the scene.
EnvironmentGlowBlendMode ENV_GLOW_BLEND_MODE_SCREEN = 1
Adds the glow effect to the scene after modifying the glow influence based on the scene value; dark values will be highly influenced by glow and bright values will not be influenced by glow. This approach avoids bright values becoming overly bright from the glow effect. Environment.tonemap_white is used to determine the maximum scene value where the glow should have no influence. When Environment.tonemap_mode is set to Environment.TONE_MAPPER_LINEAR and Viewport.use_hdr_2d is true, the parent window's Window.get_output_max_linear_value() will be used as the maximum scene value.
EnvironmentGlowBlendMode ENV_GLOW_BLEND_MODE_SOFTLIGHT = 2
Adds the glow effect to the tonemapped image after modifying the glow influence based on the image value; dark values and bright values will not be influenced by glow and mid-range values will be highly influenced by glow. This approach avoids bright values becoming overly bright from the glow effect. The glow will have the largest influence on image values of 0.25 and will have no influence when applied to image values greater than 1.0.
Note: This blend mode does not support HDR output because expects a maximum output value of 1.0. It is recommended to use a different blend mode when rendering to an HDR screen.
EnvironmentGlowBlendMode ENV_GLOW_BLEND_MODE_REPLACE = 3
Replaces all pixels' color by the glow effect. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness or to preview glow configuration in the editor.
EnvironmentGlowBlendMode ENV_GLOW_BLEND_MODE_MIX = 4
Mixes the glow image with the scene image. Best used with Environment.glow_bloom to avoid darkening the scene.
enum EnvironmentFogMode: 🔗
EnvironmentFogMode ENV_FOG_MODE_EXPONENTIAL = 0
Use a physically-based fog model defined primarily by fog density.
EnvironmentFogMode ENV_FOG_MODE_DEPTH = 1
Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control.
enum EnvironmentToneMapper: 🔗
EnvironmentToneMapper ENV_TONE_MAPPER_LINEAR = 0
Does not modify color data, resulting in a linear tonemapping curve which unnaturally clips bright values, causing bright lighting to look blown out. The simplest and fastest tonemapper.
EnvironmentToneMapper ENV_TONE_MAPPER_REINHARD = 1
A simple tonemapping curve that rolls off bright values to prevent clipping. This results in an image that can appear dull and low contrast. Slower than ENV_TONE_MAPPER_LINEAR.
Note: When Environment.tonemap_white is left at the default value of 1.0, ENV_TONE_MAPPER_REINHARD produces an identical image to ENV_TONE_MAPPER_LINEAR.
EnvironmentToneMapper ENV_TONE_MAPPER_FILMIC = 2
Uses a film-like tonemapping curve to prevent clipping of bright values and provide better contrast than ENV_TONE_MAPPER_REINHARD. Slightly slower than ENV_TONE_MAPPER_REINHARD.
Note: This tonemapper does not support HDR output because it produces output in the SDR range. It is recommended to use a different tonemapper when rendering to an HDR screen.
EnvironmentToneMapper ENV_TONE_MAPPER_ACES = 3
Uses a high-contrast film-like tonemapping curve and desaturates bright values for a more realistic appearance. Slightly slower than ENV_TONE_MAPPER_FILMIC.
Note: This tonemapping operator is called "ACES Fitted" in Godot 3.x.
Note: This tonemapper does not support HDR output because it produces output in the SDR range. It is recommended to use a different tonemapper when rendering to an HDR screen.
EnvironmentToneMapper ENV_TONE_MAPPER_AGX = 4
Uses an adjustable film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option.
enum EnvironmentSSRRoughnessQuality: 🔗
EnvironmentSSRRoughnessQuality ENV_SSR_ROUGHNESS_QUALITY_DISABLED = 0
Lowest quality of roughness filter for screen-space reflections. Rough materials will not have blurrier screen-space reflections compared to smooth (non-rough) materials. This is the fastest option.
EnvironmentSSRRoughnessQuality ENV_SSR_ROUGHNESS_QUALITY_LOW = 1
Low quality of roughness filter for screen-space reflections.
EnvironmentSSRRoughnessQuality ENV_SSR_ROUGHNESS_QUALITY_MEDIUM = 2
Medium quality of roughness filter for screen-space reflections.
EnvironmentSSRRoughnessQuality ENV_SSR_ROUGHNESS_QUALITY_HIGH = 3
High quality of roughness filter for screen-space reflections. This is the slowest option.
enum EnvironmentSSAOQuality: 🔗
EnvironmentSSAOQuality ENV_SSAO_QUALITY_VERY_LOW = 0
Lowest quality of screen-space ambient occlusion.
EnvironmentSSAOQuality ENV_SSAO_QUALITY_LOW = 1
Low quality screen-space ambient occlusion.
EnvironmentSSAOQuality ENV_SSAO_QUALITY_MEDIUM = 2
Medium quality screen-space ambient occlusion.
EnvironmentSSAOQuality ENV_SSAO_QUALITY_HIGH = 3
High quality screen-space ambient occlusion.
EnvironmentSSAOQuality ENV_SSAO_QUALITY_ULTRA = 4
Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
enum EnvironmentSSILQuality: 🔗
EnvironmentSSILQuality ENV_SSIL_QUALITY_VERY_LOW = 0
Lowest quality of screen-space indirect lighting.
EnvironmentSSILQuality ENV_SSIL_QUALITY_LOW = 1
Low quality screen-space indirect lighting.
EnvironmentSSILQuality ENV_SSIL_QUALITY_MEDIUM = 2
High quality screen-space indirect lighting.
EnvironmentSSILQuality ENV_SSIL_QUALITY_HIGH = 3
High quality screen-space indirect lighting.
EnvironmentSSILQuality ENV_SSIL_QUALITY_ULTRA = 4
Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
enum EnvironmentSDFGIYScale: 🔗
EnvironmentSDFGIYScale ENV_SDFGI_Y_SCALE_50_PERCENT = 0
Use 50% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be twice as short as they are wide. This allows providing increased GI detail and reduced light leaking with thin floors and ceilings. This is usually the best choice for scenes that don't feature much verticality.
EnvironmentSDFGIYScale ENV_SDFGI_Y_SCALE_75_PERCENT = 1
Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
EnvironmentSDFGIYScale ENV_SDFGI_Y_SCALE_100_PERCENT = 2
Use 100% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be as tall as they are wide. This is usually the best choice for highly vertical scenes. The downside is that light leaking may become more noticeable with thin floors and ceilings.
enum EnvironmentSDFGIRayCount: 🔗
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_4 = 0
Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_8 = 1
Throw 8 rays per frame when converging SDFGI.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_16 = 2
Throw 16 rays per frame when converging SDFGI.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_32 = 3
Throw 32 rays per frame when converging SDFGI.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_64 = 4
Throw 64 rays per frame when converging SDFGI.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_96 = 5
Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_128 = 6
Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
EnvironmentSDFGIRayCount ENV_SDFGI_RAY_COUNT_MAX = 7
Represents the size of the EnvironmentSDFGIRayCount enum.
enum EnvironmentSDFGIFramesToConverge: 🔗
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_IN_5_FRAMES = 0
Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_IN_10_FRAMES = 1
Configure SDFGI to fully converge over 10 frames.
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_IN_15_FRAMES = 2
Configure SDFGI to fully converge over 15 frames.
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_IN_20_FRAMES = 3
Configure SDFGI to fully converge over 20 frames.
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_IN_25_FRAMES = 4
Configure SDFGI to fully converge over 25 frames.
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_IN_30_FRAMES = 5
Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
EnvironmentSDFGIFramesToConverge ENV_SDFGI_CONVERGE_MAX = 6
Represents the size of the EnvironmentSDFGIFramesToConverge enum.
enum EnvironmentSDFGIFramesToUpdateLight: 🔗
EnvironmentSDFGIFramesToUpdateLight ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME = 0
Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
EnvironmentSDFGIFramesToUpdateLight ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES = 1
Update indirect light from dynamic lights in SDFGI over 2 frames.
EnvironmentSDFGIFramesToUpdateLight ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES = 2
Update indirect light from dynamic lights in SDFGI over 4 frames.
EnvironmentSDFGIFramesToUpdateLight ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES = 3
Update indirect light from dynamic lights in SDFGI over 8 frames.
EnvironmentSDFGIFramesToUpdateLight ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES = 4
Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
EnvironmentSDFGIFramesToUpdateLight ENV_SDFGI_UPDATE_LIGHT_MAX = 5
Represents the size of the EnvironmentSDFGIFramesToUpdateLight enum.
enum SubSurfaceScatteringQuality: 🔗
SubSurfaceScatteringQuality SUB_SURFACE_SCATTERING_QUALITY_DISABLED = 0
Disables subsurface scattering entirely, even on materials that have BaseMaterial3D.subsurf_scatter_enabled set to true. This has the lowest GPU requirements.
SubSurfaceScatteringQuality SUB_SURFACE_SCATTERING_QUALITY_LOW = 1
Low subsurface scattering quality.
SubSurfaceScatteringQuality SUB_SURFACE_SCATTERING_QUALITY_MEDIUM = 2
Medium subsurface scattering quality.
SubSurfaceScatteringQuality SUB_SURFACE_SCATTERING_QUALITY_HIGH = 3
High subsurface scattering quality. This has the highest GPU requirements.
enum DOFBokehShape: 🔗
DOFBokehShape DOF_BOKEH_BOX = 0
Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
DOFBokehShape DOF_BOKEH_HEXAGON = 1
Calculates DOF blur using a hexagon shaped filter.
DOFBokehShape DOF_BOKEH_CIRCLE = 2
Calculates DOF blur using a circle shaped filter. Best quality and most realistic, but slowest. Use only for areas where a lot of performance can be dedicated to post-processing (e.g. cutscenes).
enum DOFBlurQuality: 🔗
DOFBlurQuality DOF_BLUR_QUALITY_VERY_LOW = 0
Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
DOFBlurQuality DOF_BLUR_QUALITY_LOW = 1
Low quality DOF blur.
DOFBlurQuality DOF_BLUR_QUALITY_MEDIUM = 2
Medium quality DOF blur.
DOFBlurQuality DOF_BLUR_QUALITY_HIGH = 3
Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
enum InstanceType: 🔗
InstanceType INSTANCE_NONE = 0
The instance does not have a type.
InstanceType INSTANCE_MESH = 1
The instance is a mesh.
InstanceType INSTANCE_MULTIMESH = 2
The instance is a multimesh.
InstanceType INSTANCE_PARTICLES = 3
The instance is a particle emitter.
InstanceType INSTANCE_PARTICLES_COLLISION = 4
The instance is a GPUParticles collision shape.
InstanceType INSTANCE_LIGHT = 5
The instance is a light.
InstanceType INSTANCE_REFLECTION_PROBE = 6
The instance is a reflection probe.
InstanceType INSTANCE_DECAL = 7
The instance is a decal.
InstanceType INSTANCE_VOXEL_GI = 8
The instance is a VoxelGI.
InstanceType INSTANCE_LIGHTMAP = 9
The instance is a lightmap.
InstanceType INSTANCE_OCCLUDER = 10
The instance is an occlusion culling occluder.
InstanceType INSTANCE_VISIBLITY_NOTIFIER = 11
The instance is a visible on-screen notifier.
InstanceType INSTANCE_FOG_VOLUME = 12
The instance is a fog volume.
InstanceType INSTANCE_MAX = 13
Represents the size of the InstanceType enum.
InstanceType INSTANCE_GEOMETRY_MASK = 14
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
enum InstanceFlags: 🔗
InstanceFlags INSTANCE_FLAG_USE_BAKED_LIGHT = 0
Allows the instance to be used in baked lighting.
InstanceFlags INSTANCE_FLAG_USE_DYNAMIC_GI = 1
Allows the instance to be used with dynamic global illumination.
InstanceFlags INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE = 2
When set, manually requests to draw geometry on next frame.
InstanceFlags INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING = 3
Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
InstanceFlags INSTANCE_FLAG_MAX = 4
Represents the size of the InstanceFlags enum.
enum ShadowCastingSetting: 🔗
ShadowCastingSetting SHADOW_CASTING_SETTING_OFF = 0
Disable shadows from this instance.
ShadowCastingSetting SHADOW_CASTING_SETTING_ON = 1
Cast shadows from this instance.
ShadowCastingSetting SHADOW_CASTING_SETTING_DOUBLE_SIDED = 2
Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
ShadowCastingSetting SHADOW_CASTING_SETTING_SHADOWS_ONLY = 3
Only render the shadows from the object. The object itself will not be drawn.
enum VisibilityRangeFadeMode: 🔗
VisibilityRangeFadeMode VISIBILITY_RANGE_FADE_DISABLED = 0
Disable visibility range fading for the given instance.
VisibilityRangeFadeMode VISIBILITY_RANGE_FADE_SELF = 1
Fade-out the given instance when it approaches its visibility range limits.
VisibilityRangeFadeMode VISIBILITY_RANGE_FADE_DEPENDENCIES = 2
Fade-in the given instance's dependencies when reaching its visibility range limits.
enum BakeChannels: 🔗
BakeChannels BAKE_CHANNEL_ALBEDO_ALPHA = 0
Index of Image in array of Images returned by bake_render_uv2(). Image uses Image.FORMAT_RGBA8 and contains albedo color in the .rgb channels and alpha in the .a channel.
BakeChannels BAKE_CHANNEL_NORMAL = 1
Index of Image in array of Images returned by bake_render_uv2(). Image uses Image.FORMAT_RGBA8 and contains the per-pixel normal of the object in the .rgb channels and nothing in the .a channel. The per-pixel normal is encoded as normal * 0.5 + 0.5.
BakeChannels BAKE_CHANNEL_ORM = 2
Index of Image in array of Images returned by bake_render_uv2(). Image uses Image.FORMAT_RGBA8 and contains ambient occlusion (from material and decals only) in the .r channel, roughness in the .g channel, metallic in the .b channel and sub surface scattering amount in the .a channel.
BakeChannels BAKE_CHANNEL_EMISSION = 3
Index of Image in array of Images returned by bake_render_uv2(). Image uses Image.FORMAT_RGBAH and contains emission color in the .rgb channels and nothing in the .a channel.
enum CanvasTextureChannel: 🔗
CanvasTextureChannel CANVAS_TEXTURE_CHANNEL_DIFFUSE = 0
Diffuse canvas texture (CanvasTexture.diffuse_texture).
CanvasTextureChannel CANVAS_TEXTURE_CHANNEL_NORMAL = 1
Normal map canvas texture (CanvasTexture.normal_texture).
CanvasTextureChannel CANVAS_TEXTURE_CHANNEL_SPECULAR = 2
Specular map canvas texture (CanvasTexture.specular_texture).
enum NinePatchAxisMode: 🔗
NinePatchAxisMode NINE_PATCH_STRETCH = 0
The nine patch gets stretched where needed.
NinePatchAxisMode NINE_PATCH_TILE = 1
The nine patch gets filled with tiles where needed.
NinePatchAxisMode NINE_PATCH_TILE_FIT = 2
The nine patch gets filled with tiles where needed and stretches them a bit if needed.
enum CanvasItemTextureFilter: 🔗
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_DEFAULT = 0
Uses the default filter mode for this Viewport.
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_NEAREST = 1
The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled).
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_LINEAR = 2
The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled).
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS = 3
The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true). This makes the texture look pixelated from up close, and smooth from a distance.
Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to Camera2D zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS = 4
The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true). This makes the texture look smooth from up close, and smooth from a distance.
Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to Camera2D zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC = 5
The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.
Note: This texture filter is rarely useful in 2D projects. CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS is usually more appropriate in this case.
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC = 6
The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.
Note: This texture filter is rarely useful in 2D projects. CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS is usually more appropriate in this case.
CanvasItemTextureFilter CANVAS_ITEM_TEXTURE_FILTER_MAX = 7
Max value for CanvasItemTextureFilter enum.
enum CanvasItemTextureRepeat: 🔗
CanvasItemTextureRepeat CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT = 0
Uses the default repeat mode for this Viewport.
CanvasItemTextureRepeat CANVAS_ITEM_TEXTURE_REPEAT_DISABLED = 1
Disables textures repeating. Instead, when reading UVs outside the 0-1 range, the value will be clamped to the edge of the texture, resulting in a stretched out look at the borders of the texture.
CanvasItemTextureRepeat CANVAS_ITEM_TEXTURE_REPEAT_ENABLED = 2
Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.
CanvasItemTextureRepeat CANVAS_ITEM_TEXTURE_REPEAT_MIRROR = 3
Flip the texture when repeating so that the edge lines up instead of abruptly changing.
CanvasItemTextureRepeat CANVAS_ITEM_TEXTURE_REPEAT_MAX = 4
Max value for CanvasItemTextureRepeat enum.
enum CanvasGroupMode: 🔗
CanvasGroupMode CANVAS_GROUP_MODE_DISABLED = 0
Child draws over parent and is not clipped.
CanvasGroupMode CANVAS_GROUP_MODE_CLIP_ONLY = 1
Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
CanvasGroupMode CANVAS_GROUP_MODE_CLIP_AND_DRAW = 2
Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
CanvasGroupMode CANVAS_GROUP_MODE_TRANSPARENT = 3
There is currently no description for this enum. Please help us by contributing one!
enum CanvasLightMode: 🔗
CanvasLightMode CANVAS_LIGHT_MODE_POINT = 0
2D point light (see PointLight2D).
CanvasLightMode CANVAS_LIGHT_MODE_DIRECTIONAL = 1
2D directional (sun/moon) light (see DirectionalLight2D).
enum CanvasLightBlendMode: 🔗
CanvasLightBlendMode CANVAS_LIGHT_BLEND_MODE_ADD = 0
Adds light color additive to the canvas.
CanvasLightBlendMode CANVAS_LIGHT_BLEND_MODE_SUB = 1
Adds light color subtractive to the canvas.
CanvasLightBlendMode CANVAS_LIGHT_BLEND_MODE_MIX = 2
The light adds color depending on transparency.
enum CanvasLightShadowFilter: 🔗
CanvasLightShadowFilter CANVAS_LIGHT_FILTER_NONE = 0
Do not apply a filter to canvas light shadows.
CanvasLightShadowFilter CANVAS_LIGHT_FILTER_PCF5 = 1
Use PCF5 filtering to filter canvas light shadows.
CanvasLightShadowFilter CANVAS_LIGHT_FILTER_PCF13 = 2
Use PCF13 filtering to filter canvas light shadows.
CanvasLightShadowFilter CANVAS_LIGHT_FILTER_MAX = 3
Max value of the CanvasLightShadowFilter enum.
enum CanvasOccluderPolygonCullMode: 🔗
CanvasOccluderPolygonCullMode CANVAS_OCCLUDER_POLYGON_CULL_DISABLED = 0
Culling of the canvas occluder is disabled.
CanvasOccluderPolygonCullMode CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE = 1
Culling of the canvas occluder is clockwise.
CanvasOccluderPolygonCullMode CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE = 2
Culling of the canvas occluder is counterclockwise.
enum GlobalShaderParameterType: 🔗
GlobalShaderParameterType GLOBAL_VAR_TYPE_BOOL = 0
Boolean global shader parameter (global uniform bool ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_BVEC2 = 1
2-dimensional boolean vector global shader parameter (global uniform bvec2 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_BVEC3 = 2
3-dimensional boolean vector global shader parameter (global uniform bvec3 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_BVEC4 = 3
4-dimensional boolean vector global shader parameter (global uniform bvec4 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_INT = 4
Integer global shader parameter (global uniform int ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_IVEC2 = 5
2-dimensional integer vector global shader parameter (global uniform ivec2 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_IVEC3 = 6
3-dimensional integer vector global shader parameter (global uniform ivec3 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_IVEC4 = 7
4-dimensional integer vector global shader parameter (global uniform ivec4 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_RECT2I = 8
2-dimensional integer rectangle global shader parameter (global uniform ivec4 ...). Equivalent to GLOBAL_VAR_TYPE_IVEC4 in shader code, but exposed as a Rect2i in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_UINT = 9
Unsigned integer global shader parameter (global uniform uint ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_UVEC2 = 10
2-dimensional unsigned integer vector global shader parameter (global uniform uvec2 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_UVEC3 = 11
3-dimensional unsigned integer vector global shader parameter (global uniform uvec3 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_UVEC4 = 12
4-dimensional unsigned integer vector global shader parameter (global uniform uvec4 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_FLOAT = 13
Single-precision floating-point global shader parameter (global uniform float ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_VEC2 = 14
2-dimensional floating-point vector global shader parameter (global uniform vec2 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_VEC3 = 15
3-dimensional floating-point vector global shader parameter (global uniform vec3 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_VEC4 = 16
4-dimensional floating-point vector global shader parameter (global uniform vec4 ...).
GlobalShaderParameterType GLOBAL_VAR_TYPE_COLOR = 17
Color global shader parameter (global uniform vec4 ...). Equivalent to GLOBAL_VAR_TYPE_VEC4 in shader code, but exposed as a Color in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_RECT2 = 18
2-dimensional floating-point rectangle global shader parameter (global uniform vec4 ...). Equivalent to GLOBAL_VAR_TYPE_VEC4 in shader code, but exposed as a Rect2 in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_MAT2 = 19
2×2 matrix global shader parameter (global uniform mat2 ...). Exposed as a PackedInt32Array in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_MAT3 = 20
3×3 matrix global shader parameter (global uniform mat3 ...). Exposed as a Basis in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_MAT4 = 21
4×4 matrix global shader parameter (global uniform mat4 ...). Exposed as a Projection in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_TRANSFORM_2D = 22
2-dimensional transform global shader parameter (global uniform mat2x3 ...). Exposed as a Transform2D in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_TRANSFORM = 23
3-dimensional transform global shader parameter (global uniform mat3x4 ...). Exposed as a Transform3D in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_SAMPLER2D = 24
2D sampler global shader parameter (global uniform sampler2D ...). Exposed as a Texture2D in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_SAMPLER2DARRAY = 25
2D sampler array global shader parameter (global uniform sampler2DArray ...). Exposed as a Texture2DArray in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_SAMPLER3D = 26
3D sampler global shader parameter (global uniform sampler3D ...). Exposed as a Texture3D in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_SAMPLERCUBE = 27
Cubemap sampler global shader parameter (global uniform samplerCube ...). Exposed as a Cubemap in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_SAMPLEREXT = 28
External sampler global shader parameter (global uniform samplerExternalOES ...). Exposed as an ExternalTexture in the editor UI.
GlobalShaderParameterType GLOBAL_VAR_TYPE_MAX = 29
Represents the size of the GlobalShaderParameterType enum.
enum RenderingInfo: 🔗
RenderingInfo RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME = 0
Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
RenderingInfo RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME = 1
Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
RenderingInfo RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME = 2
Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
RenderingInfo RENDERING_INFO_TEXTURE_MEM_USED = 3
Texture memory used (in bytes).
RenderingInfo RENDERING_INFO_BUFFER_MEM_USED = 4
Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
RenderingInfo RENDERING_INFO_VIDEO_MEM_USED = 5
Video memory used (in bytes). When using the Forward+ or Mobile renderers, this is always greater than the sum of RENDERING_INFO_TEXTURE_MEM_USED and RENDERING_INFO_BUFFER_MEM_USED, since there is miscellaneous data not accounted for by those two metrics. When using the Compatibility renderer, this is equal to the sum of RENDERING_INFO_TEXTURE_MEM_USED and RENDERING_INFO_BUFFER_MEM_USED.
RenderingInfo RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS = 6
Number of pipeline compilations that were triggered by the 2D canvas renderer.
RenderingInfo RENDERING_INFO_PIPELINE_COMPILATIONS_MESH = 7
Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required.
RenderingInfo RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE = 8
Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading a scene the first time a user runs the game and the pipeline is required.
RenderingInfo RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW = 9
Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required.
RenderingInfo RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION = 10
Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever.
enum PipelineSource: 🔗
PipelineSource PIPELINE_SOURCE_CANVAS = 0
Pipeline compilation that was triggered by the 2D canvas renderer.
PipelineSource PIPELINE_SOURCE_MESH = 1
Pipeline compilation that was triggered by loading a mesh.
PipelineSource PIPELINE_SOURCE_SURFACE = 2
Pipeline compilation that was triggered by building the surface cache before rendering the scene.
PipelineSource PIPELINE_SOURCE_DRAW = 3
Pipeline compilation that was triggered while drawing the scene.
PipelineSource PIPELINE_SOURCE_SPECIALIZATION = 4
Pipeline compilation that was triggered to optimize the current scene.
PipelineSource PIPELINE_SOURCE_MAX = 5
Represents the size of the PipelineSource enum.
enum SplashStretchMode: 🔗
SplashStretchMode SPLASH_STRETCH_MODE_DISABLED = 0
No stretching is applied.
SplashStretchMode SPLASH_STRETCH_MODE_KEEP = 1
Stretches image to fullscreen while preserving aspect ratio.
SplashStretchMode SPLASH_STRETCH_MODE_KEEP_WIDTH = 2
Stretches the height of the image based on the width of the screen.
SplashStretchMode SPLASH_STRETCH_MODE_KEEP_HEIGHT = 3
Stretches the width of the image based on the height of the screen.
SplashStretchMode SPLASH_STRETCH_MODE_COVER = 4
Stretches the image to cover the entire screen while preserving aspect ratio.
SplashStretchMode SPLASH_STRETCH_MODE_IGNORE = 5
Stretches the image to cover the entire screen but doesn't preserve aspect ratio.
enum Features: 🔗
Features FEATURE_SHADERS = 0
Deprecated: This constant has not been used since Godot 3.0.
Features FEATURE_MULTITHREADED = 1
Deprecated: This constant has not been used since Godot 3.0.
Constants
NO_INDEX_ARRAY = -1 🔗
Marks an error that shows that the index array is empty.
ARRAY_WEIGHTS_SIZE = 4 🔗
Number of weights/bones per vertex.
CANVAS_ITEM_Z_MIN = -4096 🔗
The minimum Z-layer for canvas items.
CANVAS_ITEM_Z_MAX = 4096 🔗
The maximum Z-layer for canvas items.
CANVAS_LAYER_MIN = -2147483648 🔗
The minimum canvas layer.
CANVAS_LAYER_MAX = 2147483647 🔗
The maximum canvas layer.
MAX_GLOW_LEVELS = 7 🔗
The maximum number of glow levels that can be used with the glow post-processing effect.
MAX_CURSORS = 8 🔗
Deprecated: This constant is not used by the engine.
MAX_2D_DIRECTIONAL_LIGHTS = 8 🔗
The maximum number of directional lights that can be rendered at a given time in 2D.
MAX_MESH_SURFACES = 256 🔗
The maximum number of surfaces a mesh can have.
MATERIAL_RENDER_PRIORITY_MIN = -128 🔗
The minimum renderpriority of all materials.
MATERIAL_RENDER_PRIORITY_MAX = 127 🔗
The maximum renderpriority of all materials.
ARRAY_CUSTOM_COUNT = 4 🔗
The number of custom data arrays available (ARRAY_CUSTOM0, ARRAY_CUSTOM1, ARRAY_CUSTOM2, ARRAY_CUSTOM3).
PARTICLES_EMIT_FLAG_POSITION = 1 🔗
Particle starts at the specified position.
PARTICLES_EMIT_FLAG_ROTATION_SCALE = 2 🔗
Particle starts with specified rotation and scale.
PARTICLES_EMIT_FLAG_VELOCITY = 4 🔗
Particle starts with the specified velocity vector, which defines the emission direction and speed.
PARTICLES_EMIT_FLAG_COLOR = 8 🔗
Particle starts with specified color.
PARTICLES_EMIT_FLAG_CUSTOM = 16 🔗
Particle starts with specified CUSTOM data.
Property Descriptions
If false, disables rendering completely, but the engine logic is still being processed. You can call force_draw() to draw a frame even with rendering disabled.
Method Descriptions
Creates a new area light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most light_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
To place in a scene, attach this area light to an instance using instance_set_base() using the returned RID.
Note: The equivalent node is AreaLight3D.
Array[Image] bake_render_uv2(base: RID, material_overrides: Array[RID], image_size: Vector2i) 🔗
Bakes the material data of the Mesh passed in the base parameter with optional material_overrides to a set of Images of size image_size. Returns an array of Images containing material properties as specified in BakeChannels.
void call_on_render_thread(callable: Callable) 🔗
As the RenderingServer actual logic may run on a separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as RenderingDevice and similar RD classes), push a callable via this function so it will be executed on the render thread.
RID camera_attributes_create() 🔗
Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all camera_attributes_ RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent resource is CameraAttributes.
void camera_attributes_set_auto_exposure(camera_attributes: RID, enable: bool, min_sensitivity: float, max_sensitivity: float, speed: float, scale: float) 🔗
Sets the parameters to use with the auto-exposure effect. These parameters take on the same meaning as their counterparts in CameraAttributes and CameraAttributesPractical.
void camera_attributes_set_dof_blur(camera_attributes: RID, far_enable: bool, far_distance: float, far_transition: float, near_enable: bool, near_distance: float, near_transition: float, amount: float) 🔗
Sets the parameters to use with the DOF blur effect. These parameters take on the same meaning as their counterparts in CameraAttributesPractical.
void camera_attributes_set_dof_blur_bokeh_shape(shape: DOFBokehShape) 🔗
Sets the shape of the DOF bokeh pattern to shape. Different shapes may be used to achieve artistic effect, or to meet performance targets.
void camera_attributes_set_dof_blur_quality(quality: DOFBlurQuality, use_jitter: bool) 🔗
Sets the quality level of the DOF blur effect to quality. use_jitter can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy.
void camera_attributes_set_exposure(camera_attributes: RID, multiplier: float, normalization: float) 🔗
Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene.
The normalization factor can be calculated from exposure value (EV100) as follows:
func get_exposure_normalization(ev100: float):
return 1.0 / (pow(2.0, ev100) * 1.2)
The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
func get_exposure(aperture: float, shutter_speed: float, sensitivity: float):
return log((aperture * aperture) / shutter_speed * (100.0 / sensitivity)) / log(2)
Creates a 3D camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all camera_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent node is Camera3D.
void camera_set_camera_attributes(camera: RID, effects: RID) 🔗
Sets the camera_attributes created with camera_attributes_create() to the given camera.
void camera_set_compositor(camera: RID, compositor: RID) 🔗
Sets the compositor used by this camera. Equivalent to Camera3D.compositor.
void camera_set_cull_mask(camera: RID, layers: int) 🔗
Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to Camera3D.cull_mask.
void camera_set_environment(camera: RID, env: RID) 🔗
Sets the environment used by this camera. Equivalent to Camera3D.environment.
void camera_set_frustum(camera: RID, size: float, offset: Vector2, z_near: float, z_far: float) 🔗
Sets camera to use frustum projection. This mode allows adjusting the offset argument to create "tilted frustum" effects.
void camera_set_orthogonal(camera: RID, size: float, z_near: float, z_far: float) 🔗
Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are.
void camera_set_perspective(camera: RID, fovy_degrees: float, z_near: float, z_far: float) 🔗
Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
void camera_set_transform(camera: RID, transform: Transform3D) 🔗
Sets Transform3D of camera.
void camera_set_use_vertical_aspect(camera: RID, enable: bool) 🔗
If true, preserves the horizontal aspect ratio which is equivalent to Camera3D.KEEP_WIDTH. If false, preserves the vertical aspect ratio which is equivalent to Camera3D.KEEP_HEIGHT.
Creates a canvas and returns the assigned RID. It can be accessed with the RID that is returned. This RID will be used in all canvas_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Canvas has no Resource or Node equivalent.
void canvas_item_add_animation_slice(item: RID, animation_length: float, slice_begin: float, slice_end: float, offset: float = 0.0) 🔗
Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
void canvas_item_add_circle(item: RID, pos: Vector2, radius: float, color: Color, antialiased: bool = false) 🔗
Draws a circle on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_circle().
void canvas_item_add_clip_ignore(item: RID, ignore: bool) 🔗
If ignore is true, ignore clipping on items drawn with this canvas item until this is called again with ignore set to false.
void canvas_item_add_ellipse(item: RID, pos: Vector2, major: float, minor: float, color: Color, antialiased: bool = false) 🔗
Draws an ellipse with semi-major axis major and semi-minor axis minor on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_ellipse().
void canvas_item_add_lcd_texture_rect_region(item: RID, rect: Rect2, texture: RID, src_rect: Rect2, modulate: Color) 🔗
See also CanvasItem.draw_lcd_texture_rect_region().
void canvas_item_add_line(item: RID, from: Vector2, to: Vector2, color: Color, width: float = -1.0, antialiased: bool = false) 🔗
Draws a line on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_line().
void canvas_item_add_mesh(item: RID, mesh: RID, transform: Transform2D = Transform2D(1, 0, 0, 1, 0, 0), modulate: Color = Color(1, 1, 1, 1), texture: RID = RID()) 🔗
Draws a mesh created with mesh_create() with given transform, modulate color, and texture. This is used internally by MeshInstance2D.
void canvas_item_add_msdf_texture_rect_region(item: RID, rect: Rect2, texture: RID, src_rect: Rect2, modulate: Color = Color(1, 1, 1, 1), outline_size: int = 0, px_range: float = 1.0, scale: float = 1.0) 🔗
See also CanvasItem.draw_msdf_texture_rect_region().
void canvas_item_add_multiline(item: RID, points: PackedVector2Array, colors: PackedColorArray, width: float = -1.0, antialiased: bool = false) 🔗
Draws a 2D multiline on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_multiline() and CanvasItem.draw_multiline_colors().
void canvas_item_add_multimesh(item: RID, mesh: RID, texture: RID = RID()) 🔗
Draws a 2D MultiMesh on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_multimesh().
void canvas_item_add_nine_patch(item: RID, rect: Rect2, source: Rect2, texture: RID, topleft: Vector2, bottomright: Vector2, x_axis_mode: NinePatchAxisMode = 0, y_axis_mode: NinePatchAxisMode = 0, draw_center: bool = true, modulate: Color = Color(1, 1, 1, 1)) 🔗
Draws a nine-patch rectangle on the CanvasItem pointed to by the item RID.
void canvas_item_add_particles(item: RID, particles: RID, texture: RID) 🔗
Draws particles on the CanvasItem pointed to by the item RID.
void canvas_item_add_polygon(item: RID, points: PackedVector2Array, colors: PackedColorArray, uvs: PackedVector2Array = PackedVector2Array(), texture: RID = RID()) 🔗
Draws a 2D polygon on the CanvasItem pointed to by the item RID. If you need more flexibility (such as being able to use bones), use canvas_item_add_triangle_array() instead. See also CanvasItem.draw_polygon().
Note: If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with Geometry2D.triangulate_polygon() and using CanvasItem.draw_mesh(), CanvasItem.draw_multimesh(), or canvas_item_add_triangle_array().
void canvas_item_add_polyline(item: RID, points: PackedVector2Array, colors: PackedColorArray, width: float = -1.0, antialiased: bool = false) 🔗
Draws a 2D polyline on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_polyline() and CanvasItem.draw_polyline_colors().
void canvas_item_add_primitive(item: RID, points: PackedVector2Array, colors: PackedColorArray, uvs: PackedVector2Array, texture: RID) 🔗
Draws a 2D primitive on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_primitive().
void canvas_item_add_rect(item: RID, rect: Rect2, color: Color, antialiased: bool = false) 🔗
Draws a rectangle on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_rect().
void canvas_item_add_set_transform(item: RID, transform: Transform2D) 🔗
Sets a Transform2D that will be used to transform subsequent canvas item commands.
void canvas_item_add_texture_rect(item: RID, rect: Rect2, texture: RID, tile: bool = false, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false) 🔗
Draws a 2D textured rectangle on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_texture_rect() and Texture2D.draw_rect().
void canvas_item_add_texture_rect_region(item: RID, rect: Rect2, texture: RID, src_rect: Rect2, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false, clip_uv: bool = true) 🔗
Draws the specified region of a 2D textured rectangle on the CanvasItem pointed to by the item RID. See also CanvasItem.draw_texture_rect_region() and Texture2D.draw_rect_region().
void canvas_item_add_triangle_array(item: RID, indices: PackedInt32Array, points: PackedVector2Array, colors: PackedColorArray, uvs: PackedVector2Array = PackedVector2Array(), bones: PackedInt32Array = PackedInt32Array(), weights: PackedFloat32Array = PackedFloat32Array(), texture: RID = RID(), count: int = -1) 🔗
Draws a triangle array on the CanvasItem pointed to by the item RID. This is internally used by Line2D and StyleBoxFlat for rendering. canvas_item_add_triangle_array() is highly flexible, but more complex to use than canvas_item_add_polygon().
Note: If count is set to a non-negative value, only the first count * 3 indices (corresponding to count triangles) will be drawn. Otherwise, all indices are drawn.
void canvas_item_attach_skeleton(item: RID, skeleton: RID) 🔗
Attaches a skeleton to the CanvasItem. Removes the previous skeleton.
void canvas_item_clear(item: RID) 🔗
Clears the CanvasItem and removes all commands in it.
Creates a new CanvasItem instance and returns its RID. It can be accessed with the RID that is returned. This RID will be used in all canvas_item_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent node is CanvasItem.
Variant canvas_item_get_instance_shader_parameter(instance: RID, parameter: StringName) const 🔗
Returns the value of the per-instance shader uniform from the specified canvas item instance. Equivalent to CanvasItem.get_instance_shader_parameter().
Variant canvas_item_get_instance_shader_parameter_default_value(instance: RID, parameter: StringName) const 🔗
Returns the default value of the per-instance shader uniform from the specified canvas item instance. Equivalent to CanvasItem.get_instance_shader_parameter().
Array[Dictionary] canvas_item_get_instance_shader_parameter_list(instance: RID) const 🔗
Returns a dictionary of per-instance shader uniform names of the per-instance shader uniform from the specified canvas item instance.
The returned dictionary is in PropertyInfo format, with the keys name, class_name, type, hint, hint_string, and usage.
void canvas_item_reset_physics_interpolation(item: RID) 🔗
Prevents physics interpolation for the current physics tick.
This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
void canvas_item_set_canvas_group_mode(item: RID, mode: CanvasGroupMode, clear_margin: float = 5.0, fit_empty: bool = false, fit_margin: float = 0.0, blur_mipmaps: bool = false) 🔗
Sets the canvas group mode used during 2D rendering for the canvas item specified by the item RID. For faster but more limited clipping, use canvas_item_set_clip() instead.
Note: The equivalent node functionality is found in CanvasGroup and CanvasItem.clip_children.
void canvas_item_set_clip(item: RID, clip: bool) 🔗
If clip is true, makes the canvas item specified by the item RID not draw anything outside of its rect's coordinates. This clipping is fast, but works only with axis-aligned rectangles. This means that rotation is ignored by the clipping rectangle. For more advanced clipping shapes, use canvas_item_set_canvas_group_mode() instead.
Note: The equivalent node functionality is found in Label.clip_text, RichTextLabel (always enabled) and more.
void canvas_item_set_copy_to_backbuffer(item: RID, enabled: bool, rect: Rect2) 🔗
Sets the CanvasItem to copy a rect to the backbuffer.
void canvas_item_set_custom_rect(item: RID, use_custom_rect: bool, rect: Rect2 = Rect2(0, 0, 0, 0)) 🔗
If use_custom_rect is true, sets the custom visibility rectangle (used for culling) to rect for the canvas item specified by item. Setting a custom visibility rect can reduce CPU load when drawing lots of 2D instances. If use_custom_rect is false, automatically computes a visibility rectangle based on the canvas item's draw commands.
void canvas_item_set_default_texture_filter(item: RID, filter: CanvasItemTextureFilter) 🔗
Sets the default texture filter mode for the canvas item specified by the item RID. Equivalent to CanvasItem.texture_filter.
void canvas_item_set_default_texture_repeat(item: RID, repeat: CanvasItemTextureRepeat) 🔗
Sets the default texture repeat mode for the canvas item specified by the item RID. Equivalent to CanvasItem.texture_repeat.
void canvas_item_set_distance_field_mode(item: RID, enabled: bool) 🔗
If enabled is true, enables multichannel signed distance field rendering mode for the canvas item specified by the item RID. This is meant to be used for font rendering, or with specially generated images using msdfgen.
void canvas_item_set_draw_behind_parent(item: RID, enabled: bool) 🔗
If enabled is true, draws the canvas item specified by the item RID behind its parent. Equivalent to CanvasItem.show_behind_parent.
void canvas_item_set_draw_index(item: RID, index: int) 🔗
Sets the index for the CanvasItem.
void canvas_item_set_instance_shader_parameter(instance: RID, parameter: StringName, value: Variant) 🔗
Sets the per-instance shader uniform on the specified canvas item instance. Equivalent to CanvasItem.set_instance_shader_parameter().
void canvas_item_set_interpolated(item: RID, interpolated: bool) 🔗
If interpolated is true, turns on physics interpolation for the canvas item.
void canvas_item_set_light_mask(item: RID, mask: int) 🔗
Sets the light mask for the canvas item specified by the item RID. Equivalent to CanvasItem.light_mask.
void canvas_item_set_material(item: RID, material: RID) 🔗
Sets a new material to the canvas item specified by the item RID. Equivalent to CanvasItem.material.
void canvas_item_set_modulate(item: RID, color: Color) 🔗
Multiplies the color of the canvas item specified by the item RID, while affecting its children. See also canvas_item_set_self_modulate(). Equivalent to CanvasItem.modulate.
void canvas_item_set_parent(item: RID, parent: RID) 🔗
Sets a parent CanvasItem to the CanvasItem. The item will inherit transform, modulation and visibility from its parent, like CanvasItem nodes in the scene tree.
void canvas_item_set_self_modulate(item: RID, color: Color) 🔗
Multiplies the color of the canvas item specified by the item RID, without affecting its children. See also canvas_item_set_modulate(). Equivalent to CanvasItem.self_modulate.
void canvas_item_set_sort_children_by_y(item: RID, enabled: bool) 🔗
If enabled is true, child nodes with the lowest Y position are drawn before those with a higher Y position. Y-sorting only affects children that inherit from the canvas item specified by the item RID, not the canvas item itself. Equivalent to CanvasItem.y_sort_enabled.
void canvas_item_set_transform(item: RID, transform: Transform2D) 🔗
Sets the transform of the canvas item specified by the item RID. This affects where and how the item will be drawn. Child canvas items' transforms are multiplied by their parent's transform. Equivalent to Node2D.transform.
void canvas_item_set_use_parent_material(item: RID, enabled: bool) 🔗
Sets if the CanvasItem uses its parent's material.
void canvas_item_set_visibility_layer(item: RID, visibility_layer: int) 🔗
Sets the rendering visibility layer associated with this CanvasItem. Only Viewport nodes with a matching rendering mask will render this CanvasItem.
void canvas_item_set_visibility_notifier(item: RID, enable: bool, area: Rect2, enter_callable: Callable, exit_callable: Callable) 🔗
Sets the given CanvasItem as visibility notifier. area defines the area of detecting visibility. enter_callable is called when the CanvasItem enters the screen, exit_callable is called when the CanvasItem exits the screen. If enable is false, the item will no longer function as notifier.
This method can be used to manually mimic VisibleOnScreenNotifier2D.
void canvas_item_set_visible(item: RID, visible: bool) 🔗
Sets the visibility of the CanvasItem.
void canvas_item_set_z_as_relative_to_parent(item: RID, enabled: bool) 🔗
If this is enabled, the Z index of the parent will be added to the children's Z index.
void canvas_item_set_z_index(item: RID, z_index: int) 🔗
Sets the CanvasItem's Z index, i.e. its draw order (lower indexes are drawn first).
void canvas_item_transform_physics_interpolation(item: RID, transform: Transform2D) 🔗
Transforms both the current and previous stored transform for a canvas item.
This allows transforming a canvas item without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
void canvas_light_attach_to_canvas(light: RID, canvas: RID) 🔗
Attaches the canvas light to the canvas. Removes it from its previous canvas.
Creates a canvas light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_light_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent node is Light2D.
void canvas_light_occluder_attach_to_canvas(occluder: RID, canvas: RID) 🔗
Attaches a light occluder to the canvas. Removes it from its previous canvas.
RID canvas_light_occluder_create() 🔗
Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_light_occluder_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent node is LightOccluder2D.
void canvas_light_occluder_reset_physics_interpolation(occluder: RID) 🔗
Prevents physics interpolation for the current physics tick.
This is useful when moving an occluder to a new location, to give an instantaneous change rather than interpolation from the previous location.
void canvas_light_occluder_set_as_sdf_collision(occluder: RID, enable: bool) 🔗
Enables or disables using the light occluder as a signed distance field for 2D particle collision.
void canvas_light_occluder_set_enabled(occluder: RID, enabled: bool) 🔗
Enables or disables light occluder.
void canvas_light_occluder_set_interpolated(occluder: RID, interpolated: bool) 🔗
If interpolated is true, turns on physics interpolation for the light occluder.
void canvas_light_occluder_set_light_mask(occluder: RID, mask: int) 🔗
The light mask. See LightOccluder2D for more information on light masks.
void canvas_light_occluder_set_polygon(occluder: RID, polygon: RID) 🔗
Sets a light occluder's polygon.
void canvas_light_occluder_set_transform(occluder: RID, transform: Transform2D) 🔗
Sets a light occluder's Transform2D.
void canvas_light_occluder_transform_physics_interpolation(occluder: RID, transform: Transform2D) 🔗
Transforms both the current and previous stored transform for a light occluder.
This allows transforming an occluder without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
void canvas_light_reset_physics_interpolation(light: RID) 🔗
Prevents physics interpolation for the current physics tick.
This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
void canvas_light_set_blend_mode(light: RID, mode: CanvasLightBlendMode) 🔗
Sets the blend mode for the given canvas light to mode. Equivalent to Light2D.blend_mode.
void canvas_light_set_color(light: RID, color: Color) 🔗
Sets the color for a light.
void canvas_light_set_enabled(light: RID, enabled: bool) 🔗
Enables or disables a canvas light.
void canvas_light_set_energy(light: RID, energy: float) 🔗
Sets a canvas light's energy.
void canvas_light_set_height(light: RID, height: float) 🔗
Sets a canvas light's height.
void canvas_light_set_interpolated(light: RID, interpolated: bool) 🔗
If interpolated is true, turns on physics interpolation for the canvas light.
void canvas_light_set_item_cull_mask(light: RID, mask: int) 🔗
The light mask. See LightOccluder2D for more information on light masks.
void canvas_light_set_item_shadow_cull_mask(light: RID, mask: int) 🔗
The binary mask used to determine which layers this canvas light's shadows affects. See LightOccluder2D for more information on light masks.
void canvas_light_set_layer_range(light: RID, min_layer: int, max_layer: int) 🔗
The layer range that gets rendered with this light.
void canvas_light_set_mode(light: RID, mode: CanvasLightMode) 🔗
Sets the mode of the canvas light.
void canvas_light_set_shadow_color(light: RID, color: Color) 🔗
Sets the color of the canvas light's shadow.
void canvas_light_set_shadow_enabled(light: RID, enabled: bool) 🔗
Enables or disables the canvas light's shadow.
void canvas_light_set_shadow_filter(light: RID, filter: CanvasLightShadowFilter) 🔗
Sets the canvas light's shadow's filter.
void canvas_light_set_shadow_smooth(light: RID, smooth: float) 🔗
Smoothens the shadow. The lower, the smoother.
void canvas_light_set_texture(light: RID, texture: RID) 🔗
Sets the texture to be used by a PointLight2D. Equivalent to PointLight2D.texture.
void canvas_light_set_texture_offset(light: RID, offset: Vector2) 🔗
Sets the offset of a PointLight2D's texture. Equivalent to PointLight2D.offset.
void canvas_light_set_texture_scale(light: RID, scale: float) 🔗
Sets the scale factor of a PointLight2D's texture. Equivalent to PointLight2D.texture_scale.
void canvas_light_set_transform(light: RID, transform: Transform2D) 🔗
Sets the canvas light's Transform2D.
void canvas_light_set_z_range(light: RID, min_z: int, max_z: int) 🔗
Sets the Z range of objects that will be affected by this light. Equivalent to Light2D.range_z_min and Light2D.range_z_max.
void canvas_light_transform_physics_interpolation(light: RID, transform: Transform2D) 🔗
Transforms both the current and previous stored transform for a canvas light.
This allows transforming a light without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
RID canvas_occluder_polygon_create() 🔗
Creates a new light occluder polygon and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_occluder_polygon_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent resource is OccluderPolygon2D.
void canvas_occluder_polygon_set_cull_mode(occluder_polygon: RID, mode: CanvasOccluderPolygonCullMode) 🔗
Sets an occluder polygon's cull mode.
void canvas_occluder_polygon_set_shape(occluder_polygon: RID, shape: PackedVector2Array, closed: bool) 🔗
Sets the shape of the occluder polygon.
void canvas_set_disable_scale(disable: bool) 🔗
If disable is true, makes 2D rendering ignore the canvas scale defined for each canvas layer. This affects CanvasLayers with the CanvasLayer.follow_viewport_enabled property set to true.
In the editor, this is set to true by default, and set to false when View > Preview Canvas Scale is enabled at the top of the 2D editor viewport.
Note: Setting this to true does not impact the behavior of CanvasLayer.scale, Node2D.scale, or Control.scale.
void canvas_set_item_mirroring(canvas: RID, item: RID, mirroring: Vector2) 🔗
A copy of the canvas item will be drawn with a local offset of the mirroring.
Note: This is equivalent to calling canvas_set_item_repeat() like canvas_set_item_repeat(item, mirroring, 1), with an additional check ensuring canvas is a parent of item.
void canvas_set_item_repeat(item: RID, repeat_size: Vector2, repeat_times: int) 🔗
A copy of the canvas item will be drawn with a local offset of the repeat_size by the number of times of the repeat_times. As the repeat_times increases, the copies will spread away from the origin texture.
void canvas_set_modulate(canvas: RID, color: Color) 🔗
Modulates all colors in the given canvas.
void canvas_set_shadow_texture_size(size: int) 🔗
Sets the ProjectSettings.rendering/2d/shadow_atlas/size to use for Light2D shadow rendering (in pixels). The value is rounded up to the nearest power of 2.
Creates a canvas texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_texture_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method. See also texture_2d_create().
Note: The equivalent resource is CanvasTexture and is only meant to be used in 2D rendering, not 3D.
void canvas_texture_set_channel(canvas_texture: RID, channel: CanvasTextureChannel, texture: RID) 🔗
Sets the channel's texture for the canvas texture specified by the canvas_texture RID. Equivalent to CanvasTexture.diffuse_texture, CanvasTexture.normal_texture and CanvasTexture.specular_texture.
void canvas_texture_set_shading_parameters(canvas_texture: RID, base_color: Color, shininess: float) 🔗
Sets the base_color and shininess to use for the canvas texture specified by the canvas_texture RID. Equivalent to CanvasTexture.specular_color and CanvasTexture.specular_shininess.
void canvas_texture_set_texture_filter(canvas_texture: RID, filter: CanvasItemTextureFilter) 🔗
Sets the texture filter mode to use for the canvas texture specified by the canvas_texture RID.
void canvas_texture_set_texture_repeat(canvas_texture: RID, repeat: CanvasItemTextureRepeat) 🔗
Sets the texture repeat mode to use for the canvas texture specified by the canvas_texture RID.
Creates a new compositor and adds it to the RenderingServer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
RID compositor_effect_create() 🔗
Creates a new rendering effect and adds it to the RenderingServer. It can be accessed with the RID that is returned.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
void compositor_effect_set_callback(effect: RID, callback_type: CompositorEffectCallbackType, callback: Callable) 🔗
Sets the callback type (callback_type) and callback method(callback) for this rendering effect.
void compositor_effect_set_enabled(effect: RID, enabled: bool) 🔗
Enables/disables this rendering effect.
void compositor_effect_set_flag(effect: RID, flag: CompositorEffectFlags, set: bool) 🔗
Sets the flag (flag) for this rendering effect to true or false (set).
void compositor_set_compositor_effects(compositor: RID, effects: Array[RID]) 🔗
Sets the compositor effects for the specified compositor RID. effects should be an array containing RIDs created with compositor_effect_create().
RenderingDevice create_local_rendering_device() const 🔗
Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice.
Note: When using the OpenGL rendering driver or when running in headless mode, this function always returns null.
Rect2 debug_canvas_item_get_rect(item: RID) 🔗
Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling.
Warning: This function is intended for debugging in the editor, and will pass through and return a zero Rect2 in exported projects.
Creates a decal and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all decal_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
To place in a scene, attach this decal to an instance using instance_set_base() using the returned RID.
Note: The equivalent node is Decal.
void decal_set_albedo_mix(decal: RID, albedo_mix: float) 🔗
Sets the albedo_mix in the decal specified by the decal RID. Equivalent to Decal.albedo_mix.
void decal_set_cull_mask(decal: RID, mask: int) 🔗
Sets the cull mask in the decal specified by the decal RID. Equivalent to Decal.cull_mask.
void decal_set_distance_fade(decal: RID, enabled: bool, begin: float, length: float) 🔗
Sets the distance fade parameters in the decal specified by the decal RID. Equivalent to Decal.distance_fade_enabled, Decal.distance_fade_begin and Decal.distance_fade_length.
void decal_set_emission_energy(decal: RID, energy: float) 🔗
Sets the emission energy in the decal specified by the decal RID. Equivalent to Decal.emission_energy.
void decal_set_fade(decal: RID, above: float, below: float) 🔗
Sets the upper fade (above) and lower fade (below) in the decal specified by the decal RID. Equivalent to Decal.upper_fade and Decal.lower_fade.
void decal_set_modulate(decal: RID, color: Color) 🔗
Sets the color multiplier in the decal specified by the decal RID to color. Equivalent to Decal.modulate.
void decal_set_normal_fade(decal: RID, fade: float) 🔗
Sets the normal fade in the decal specified by the decal RID. Equivalent to Decal.normal_fade.
void decal_set_size(decal: RID, size: Vector3) 🔗
Sets the size of the decal specified by the decal RID. Equivalent to Decal.size.
void decal_set_texture(decal: RID, type: DecalTexture, texture: RID) 🔗
Sets the texture in the given texture type slot for the specified decal. Equivalent to Decal.set_texture().
void decals_set_filter(filter: DecalFilter) 🔗
Sets the texture filter mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
RID directional_light_create() 🔗
Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most light_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
To place in a scene, attach this directional light to an instance using instance_set_base() using the returned RID.
Note: The equivalent node is DirectionalLight3D.
void directional_shadow_atlas_set_size(size: int, is_16bits: bool) 🔗
Sets the size of the directional light shadows in 3D. See also ProjectSettings.rendering/lights_and_shadows/directional_shadow/size. This parameter is global and cannot be set on a per-viewport basis.
void directional_soft_shadow_filter_set_quality(quality: ShadowQuality) 🔗
Sets the filter quality for directional light shadows in 3D. See also ProjectSettings.rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality. This parameter is global and cannot be set on a per-viewport basis.
Image environment_bake_panorama(environment: RID, bake_irradiance: bool, size: Vector2i) 🔗
Generates and returns an Image containing the radiance map for the specified environment RID's sky. This supports built-in sky material and custom sky shaders. If bake_irradiance is true, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also sky_bake_panorama().
Note: The image is saved using linear encoding without any tonemapping performed, which means it will look too dark if viewed directly in an image editor.
Note: size should be a 2:1 aspect ratio for the generated panorama to have square pixels. For radiance maps, there is no point in using a height greater than Sky.radiance_size, as it won't increase detail. Irradiance maps only contain low-frequency data, so there is usually no point in going past a size of 128×64 pixels when saving an irradiance map.
Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all environment_* RenderingServer functions.
Once finished with your RID, you will want to free the RID using the RenderingServer's free_rid() method.
Note: The equivalent resource is Environment.
void environment_glow_set_use_bicubic_upscale(enable: bool) 🔗
If enable is true, enables bicubic upscaling for glow which improves quality at the cost of performance. Equivalent to ProjectSettings.rendering/environment/glow/upscale_mode.
Note: This setting is only effective when using the Forward+ or Mobile rendering methods, as Compatibility uses a different glow implementation.
void environment_set_adjustment(env: RID, enable: bool, brightness: float, contrast: float, saturation: float, use_1d_color_correction: bool, color_correction: RID) 🔗
Sets the values to be used with the "adjustments" post-process effect. See Environment for more details.
void environment_set_ambient_light(env: RID, color: Color, ambient: EnvironmentAmbientSource = 0, energy: float = 1.0, sky_contribution: float = 0.0, reflection_source: EnvironmentReflectionSource = 0) 🔗
Sets the values to be used for ambient light rendering. See Environment for more details.
void environment_set_background(env: RID, bg: EnvironmentBG) 🔗
Sets the environment's background mode. Equivalent to Environment.background_mode.
void environment_set_bg_color(env: RID, color: Color) 🔗
Color displayed for clear areas of the scene. Only effective if using the ENV_BG_COLOR background mode.
void environment_set_bg_energy(env: RID, multiplier: float, exposure_value: float) 🔗
Sets the intensity of the background color.
void environment_set_camera_id(env: RID, id: int) 🔗
Sets the camera ID to be used as environment background.
void environment_set_canvas_max_layer(env: RID, max_layer: int) 🔗
Sets the maximum layer to use if using Canvas background mode.
void environment_set_fog(env: RID, enable: bool, light_color: Color, light_energy: float, sun_scatter: float, density: float, height: float, height_density: float, aerial_perspective: float, sky_affect: float, fog_mode: EnvironmentFogMode = 0) 🔗
Configures fog for the specified environment RID. See fog_* properties in Environment for more information.
void environment_set_fog_depth(env: RID, curve: float, begin: float, end: float) 🔗
Configures fog depth for the specified environment RID. Only has an effect when the fog mode of the environment is ENV_FOG_MODE_DEPTH. See fog_depth_* properties in Environment for more information.
void environment_set_glow(env: RID, enable: bool, levels: PackedFloat32Array, intensity: float, strength: float, mix: float, bloom_threshold: float, blend_mode: EnvironmentGlowBlendMode, hdr_bleed_threshold: float, hdr_bleed_scale: float, hdr_luminance_cap: float, glow_map_strength: float, glow_map: RID) 🔗
Configures glow for the specified environment RID. See glow_* properties in Environment for more information.
void environment_set_sdfgi(env: RID, enable: bool, cascades: int, min_cell_size: float, y_scale: EnvironmentSDFGIYScale, use_occlusion: bool, bounce_feedback: float, read_sky: bool, energy: float, normal_bias: float, probe_bias: float) 🔗
Configures signed distance field global illumination for the specified environment RID. See sdfgi_* properties in Environment for more information.
void environment_set_sdfgi_frames_to_converge(frames: EnvironmentSDFGIFramesToConverge) 🔗
Sets the number of frames to use for converging signed distance field global illumination. Equivalent to ProjectSettings.rendering/global_illumination/sdfgi/frames_to_converge.
void environment_set_sdfgi_frames_to_update_light(frames: EnvironmentSDFGIFramesToUpdateLight) 🔗
Sets the update speed for dynamic lights' indirect lighting when computing signed distance field global illumination. Equivalent to ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights.
void environment_set_sdfgi_ray_count(ray_count: EnvironmentSDFGIRayCount) 🔗
Sets the number of rays to throw per frame when computing signed distance field global illumination. Equivalent to ProjectSettings.rendering/global_illumination/sdfgi/probe_ray_count.
void environment_set_sky(env: RID, sky: RID) 🔗
Sets the Sky to be used as the environment's background when using BGMode sky. Equivalent to Environment.sky.
void environment_set_sky_custom_fov(env: RID, scale: float) 🔗
Sets a custom field of view for the background Sky. Equivalent to Environment.sky_custom_fov.
void environment_set_sky_orientation(env: RID, orientation: Basis) 🔗
Sets the rotation of the background Sky expressed as a Basis. Equivalent to Environment.sky_rotation, where the rotation vector is used to construct the Basis.
void environment_set_ssao(env: RID, enable: bool, radius: float, intensity: float, power: float, detail: float, horizon: float, sharpness: float, light_affect: float, ao_channel_affect: float) 🔗
Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See Environment for more details.