Struct RenderingServer
#[repr(C)]pub struct RenderingServer { /* private fields */ }
Expand description
Godot class RenderingServer.
Inherits Object
.
Related symbols:
rendering_server
: sidecar module with related enum/flag typesIRenderingServer
: virtual methods
See also Godot docs for RenderingServer
.
§Singleton
This class is a singleton. You can get the one instance using RenderingServer::singleton()
.
Implementations§
§impl RenderingServer
impl RenderingServer
pub const NO_INDEX_ARRAY: i32 = -1i32
pub const ARRAY_WEIGHTS_SIZE: i32 = 4i32
pub const CANVAS_ITEM_Z_MIN: i32 = -4_096i32
pub const CANVAS_ITEM_Z_MAX: i32 = 4_096i32
pub const MAX_GLOW_LEVELS: i32 = 7i32
pub const MAX_CURSORS: i32 = 8i32
pub const MAX_2D_DIRECTIONAL_LIGHTS: i32 = 8i32
pub const MAX_MESH_SURFACES: i32 = 256i32
pub const MATERIAL_RENDER_PRIORITY_MIN: i32 = -128i32
pub const MATERIAL_RENDER_PRIORITY_MAX: i32 = 127i32
pub const ARRAY_CUSTOM_COUNT: i32 = 4i32
pub const PARTICLES_EMIT_FLAG_POSITION: i32 = 1i32
pub const PARTICLES_EMIT_FLAG_ROTATION_SCALE: i32 = 2i32
pub const PARTICLES_EMIT_FLAG_VELOCITY: i32 = 4i32
pub const PARTICLES_EMIT_FLAG_COLOR: i32 = 8i32
pub const PARTICLES_EMIT_FLAG_CUSTOM: i32 = 16i32
pub fn singleton() -> Gd<RenderingServer>
pub fn texture_2d_create(&mut self, image: impl AsObjectArg<Image>) -> Rid
pub fn texture_2d_layered_create( &mut self, layers: &Array<Gd<Image>>, layered_type: TextureLayeredType, ) -> Rid
pub fn texture_3d_create( &mut self, format: Format, width: i32, height: i32, depth: i32, mipmaps: bool, data: &Array<Gd<Image>>, ) -> Rid
pub fn texture_proxy_create(&mut self, base: Rid) -> Rid
pub fn texture_2d_update( &mut self, texture: Rid, image: impl AsObjectArg<Image>, layer: i32, )
pub fn texture_3d_update(&mut self, texture: Rid, data: &Array<Gd<Image>>)
pub fn texture_proxy_update(&mut self, texture: Rid, proxy_to: Rid)
pub fn texture_2d_placeholder_create(&mut self) -> Rid
pub fn texture_2d_layered_placeholder_create( &mut self, layered_type: TextureLayeredType, ) -> Rid
pub fn texture_3d_placeholder_create(&mut self) -> Rid
pub fn texture_2d_get(&self, texture: Rid) -> Option<Gd<Image>>
pub fn texture_2d_layer_get( &self, texture: Rid, layer: i32, ) -> Option<Gd<Image>>
pub fn texture_3d_get(&self, texture: Rid) -> Array<Gd<Image>>
pub fn texture_replace(&mut self, texture: Rid, by_texture: Rid)
pub fn texture_set_size_override( &mut self, texture: Rid, width: i32, height: i32, )
pub fn texture_set_path(&mut self, texture: Rid, path: GString)
pub fn texture_get_path(&self, texture: Rid) -> GString
pub fn texture_get_format(&self, texture: Rid) -> Format
pub fn texture_set_force_redraw_if_visible( &mut self, texture: Rid, enable: bool, )
pub fn texture_rd_create(&mut self, rd_texture: Rid) -> Rid
pub fn texture_rd_create(&mut self, rd_texture: Rid) -> Rid
To set the default parameters, use Self::texture_rd_create_ex
and its builder methods. See the book for detailed usage instructions.
pub fn texture_rd_create_ex<'a>( &'a mut self, rd_texture: Rid, ) -> ExTextureRdCreate<'a>
pub fn texture_get_rd_texture(&self, texture: Rid) -> Rid
pub fn texture_get_rd_texture(&self, texture: Rid) -> Rid
To set the default parameters, use Self::texture_get_rd_texture_ex
and its builder methods. See the book for detailed usage instructions.
pub fn texture_get_rd_texture_ex<'a>( &'a self, texture: Rid, ) -> ExTextureGetRdTexture<'a>
pub fn texture_get_native_handle(&self, texture: Rid) -> u64
pub fn texture_get_native_handle(&self, texture: Rid) -> u64
To set the default parameters, use Self::texture_get_native_handle_ex
and its builder methods. See the book for detailed usage instructions.
pub fn texture_get_native_handle_ex<'a>( &'a self, texture: Rid, ) -> ExTextureGetNativeHandle<'a>
pub fn shader_create(&mut self) -> Rid
pub fn shader_set_code(&mut self, shader: Rid, code: GString)
pub fn shader_set_path_hint(&mut self, shader: Rid, path: GString)
pub fn shader_get_code(&self, shader: Rid) -> GString
pub fn get_shader_parameter_list(&self, shader: Rid) -> Array<Dictionary>
pub fn shader_get_parameter_default( &self, shader: Rid, name: StringName, ) -> Variant
pub fn shader_set_default_texture_parameter(
&mut self,
shader: Rid,
name: StringName,
texture: Rid,
)
pub fn shader_set_default_texture_parameter( &mut self, shader: Rid, name: StringName, texture: Rid, )
To set the default parameters, use Self::shader_set_default_texture_parameter_ex
and its builder methods. See the book for detailed usage instructions.
pub fn shader_set_default_texture_parameter_ex<'a>( &'a mut self, shader: Rid, name: StringName, texture: Rid, ) -> ExShaderSetDefaultTextureParameter<'a>
pub fn shader_get_default_texture_parameter(
&self,
shader: Rid,
name: StringName,
) -> Rid
pub fn shader_get_default_texture_parameter( &self, shader: Rid, name: StringName, ) -> Rid
To set the default parameters, use Self::shader_get_default_texture_parameter_ex
and its builder methods. See the book for detailed usage instructions.
pub fn shader_get_default_texture_parameter_ex<'a>( &'a self, shader: Rid, name: StringName, ) -> ExShaderGetDefaultTextureParameter<'a>
pub fn material_create(&mut self) -> Rid
pub fn material_set_shader(&mut self, shader_material: Rid, shader: Rid)
pub fn material_set_param( &mut self, material: Rid, parameter: StringName, value: &Variant, )
pub fn material_get_param( &self, material: Rid, parameter: StringName, ) -> Variant
pub fn material_set_render_priority(&mut self, material: Rid, priority: i32)
pub fn material_set_next_pass(&mut self, material: Rid, next_material: Rid)
pub fn mesh_create_from_surfaces<'a>(
&mut self,
surfaces: &'a Array<Dictionary>,
) -> Rid
pub fn mesh_create_from_surfaces<'a>( &mut self, surfaces: &'a Array<Dictionary>, ) -> Rid
To set the default parameters, use Self::mesh_create_from_surfaces_ex
and its builder methods. See the book for detailed usage instructions.
pub fn mesh_create_from_surfaces_ex<'a>( &'a mut self, surfaces: &'a Array<Dictionary>, ) -> ExMeshCreateFromSurfaces<'a>
pub fn mesh_create(&mut self) -> Rid
pub fn mesh_surface_get_format_offset( &self, format: ArrayFormat, vertex_count: i32, array_index: i32, ) -> u32
pub fn mesh_surface_get_format_vertex_stride( &self, format: ArrayFormat, vertex_count: i32, ) -> u32
pub fn mesh_surface_get_format_normal_tangent_stride( &self, format: ArrayFormat, vertex_count: i32, ) -> u32
pub fn mesh_surface_get_format_attribute_stride( &self, format: ArrayFormat, vertex_count: i32, ) -> u32
pub fn mesh_surface_get_format_skin_stride( &self, format: ArrayFormat, vertex_count: i32, ) -> u32
pub fn mesh_add_surface(&mut self, mesh: Rid, surface: &Dictionary)
pub fn mesh_add_surface_from_arrays<'a>(
&mut self,
mesh: Rid,
primitive: PrimitiveType,
arrays: &'a Array<Variant>,
)
pub fn mesh_add_surface_from_arrays<'a>( &mut self, mesh: Rid, primitive: PrimitiveType, arrays: &'a Array<Variant>, )
To set the default parameters, use Self::mesh_add_surface_from_arrays_ex
and its builder methods. See the book for detailed usage instructions.
pub fn mesh_add_surface_from_arrays_ex<'a>( &'a mut self, mesh: Rid, primitive: PrimitiveType, arrays: &'a Array<Variant>, ) -> ExMeshAddSurfaceFromArrays<'a>
pub fn mesh_get_blend_shape_count(&self, mesh: Rid) -> i32
pub fn mesh_set_blend_shape_mode(&mut self, mesh: Rid, mode: BlendShapeMode)
pub fn mesh_get_blend_shape_mode(&self, mesh: Rid) -> BlendShapeMode
pub fn mesh_surface_set_material( &mut self, mesh: Rid, surface: i32, material: Rid, )
pub fn mesh_surface_get_material(&self, mesh: Rid, surface: i32) -> Rid
pub fn mesh_get_surface(&mut self, mesh: Rid, surface: i32) -> Dictionary
pub fn mesh_surface_get_arrays(&self, mesh: Rid, surface: i32) -> Array<Variant>
pub fn mesh_surface_get_blend_shape_arrays( &self, mesh: Rid, surface: i32, ) -> Array<Array<Variant>>
pub fn mesh_get_surface_count(&self, mesh: Rid) -> i32
pub fn mesh_set_custom_aabb(&mut self, mesh: Rid, aabb: Aabb)
pub fn mesh_get_custom_aabb(&self, mesh: Rid) -> Aabb
pub fn mesh_clear(&mut self, mesh: Rid)
pub fn mesh_surface_update_vertex_region( &mut self, mesh: Rid, surface: i32, offset: i32, data: &PackedByteArray, )
pub fn mesh_surface_update_attribute_region( &mut self, mesh: Rid, surface: i32, offset: i32, data: &PackedByteArray, )
pub fn mesh_surface_update_skin_region( &mut self, mesh: Rid, surface: i32, offset: i32, data: &PackedByteArray, )
pub fn mesh_set_shadow_mesh(&mut self, mesh: Rid, shadow_mesh: Rid)
pub fn multimesh_create(&mut self) -> Rid
pub fn multimesh_allocate_data(
&mut self,
multimesh: Rid,
instances: i32,
transform_format: MultimeshTransformFormat,
)
pub fn multimesh_allocate_data( &mut self, multimesh: Rid, instances: i32, transform_format: MultimeshTransformFormat, )
To set the default parameters, use Self::multimesh_allocate_data_ex
and its builder methods. See the book for detailed usage instructions.
pub fn multimesh_allocate_data_ex<'a>( &'a mut self, multimesh: Rid, instances: i32, transform_format: MultimeshTransformFormat, ) -> ExMultimeshAllocateData<'a>
pub fn multimesh_get_instance_count(&self, multimesh: Rid) -> i32
pub fn multimesh_set_mesh(&mut self, multimesh: Rid, mesh: Rid)
pub fn multimesh_instance_set_transform( &mut self, multimesh: Rid, index: i32, transform: Transform3D, )
pub fn multimesh_instance_set_transform_2d( &mut self, multimesh: Rid, index: i32, transform: Transform2D, )
pub fn multimesh_instance_set_color( &mut self, multimesh: Rid, index: i32, color: Color, )
pub fn multimesh_instance_set_custom_data( &mut self, multimesh: Rid, index: i32, custom_data: Color, )
pub fn multimesh_get_mesh(&self, multimesh: Rid) -> Rid
pub fn multimesh_get_aabb(&self, multimesh: Rid) -> Aabb
pub fn multimesh_set_custom_aabb(&mut self, multimesh: Rid, aabb: Aabb)
pub fn multimesh_get_custom_aabb(&self, multimesh: Rid) -> Aabb
pub fn multimesh_instance_get_transform( &self, multimesh: Rid, index: i32, ) -> Transform3D
pub fn multimesh_instance_get_transform_2d( &self, multimesh: Rid, index: i32, ) -> Transform2D
pub fn multimesh_instance_get_color(&self, multimesh: Rid, index: i32) -> Color
pub fn multimesh_instance_get_custom_data( &self, multimesh: Rid, index: i32, ) -> Color
pub fn multimesh_set_visible_instances(&mut self, multimesh: Rid, visible: i32)
pub fn multimesh_get_visible_instances(&self, multimesh: Rid) -> i32
pub fn multimesh_set_buffer( &mut self, multimesh: Rid, buffer: &PackedFloat32Array, )
pub fn multimesh_get_buffer(&self, multimesh: Rid) -> PackedFloat32Array
pub fn skeleton_create(&mut self) -> Rid
pub fn skeleton_allocate_data(&mut self, skeleton: Rid, bones: i32)
pub fn skeleton_allocate_data(&mut self, skeleton: Rid, bones: i32)
To set the default parameters, use Self::skeleton_allocate_data_ex
and its builder methods. See the book for detailed usage instructions.
pub fn skeleton_allocate_data_ex<'a>( &'a mut self, skeleton: Rid, bones: i32, ) -> ExSkeletonAllocateData<'a>
pub fn skeleton_get_bone_count(&self, skeleton: Rid) -> i32
pub fn skeleton_bone_set_transform( &mut self, skeleton: Rid, bone: i32, transform: Transform3D, )
pub fn skeleton_bone_get_transform( &self, skeleton: Rid, bone: i32, ) -> Transform3D
pub fn skeleton_bone_set_transform_2d( &mut self, skeleton: Rid, bone: i32, transform: Transform2D, )
pub fn skeleton_bone_get_transform_2d( &self, skeleton: Rid, bone: i32, ) -> Transform2D
pub fn skeleton_set_base_transform_2d( &mut self, skeleton: Rid, base_transform: Transform2D, )
pub fn directional_light_create(&mut self) -> Rid
pub fn omni_light_create(&mut self) -> Rid
pub fn spot_light_create(&mut self) -> Rid
pub fn light_set_color(&mut self, light: Rid, color: Color)
pub fn light_set_param(&mut self, light: Rid, param: LightParam, value: f32)
pub fn light_set_shadow(&mut self, light: Rid, enabled: bool)
pub fn light_set_projector(&mut self, light: Rid, texture: Rid)
pub fn light_set_negative(&mut self, light: Rid, enable: bool)
pub fn light_set_cull_mask(&mut self, light: Rid, mask: u32)
pub fn light_set_distance_fade( &mut self, decal: Rid, enabled: bool, begin: f32, shadow: f32, length: f32, )
pub fn light_set_reverse_cull_face_mode(&mut self, light: Rid, enabled: bool)
pub fn light_set_bake_mode(&mut self, light: Rid, bake_mode: LightBakeMode)
pub fn light_set_max_sdfgi_cascade(&mut self, light: Rid, cascade: u32)
pub fn light_omni_set_shadow_mode( &mut self, light: Rid, mode: LightOmniShadowMode, )
pub fn light_directional_set_shadow_mode( &mut self, light: Rid, mode: LightDirectionalShadowMode, )
pub fn light_directional_set_blend_splits(&mut self, light: Rid, enable: bool)
pub fn light_directional_set_sky_mode( &mut self, light: Rid, mode: LightDirectionalSkyMode, )
pub fn light_projectors_set_filter(&mut self, filter: LightProjectorFilter)
pub fn positional_soft_shadow_filter_set_quality( &mut self, quality: ShadowQuality, )
pub fn directional_soft_shadow_filter_set_quality( &mut self, quality: ShadowQuality, )
pub fn directional_shadow_atlas_set_size(&mut self, size: i32, is_16bits: bool)
pub fn reflection_probe_create(&mut self) -> Rid
pub fn reflection_probe_set_update_mode( &mut self, probe: Rid, mode: ReflectionProbeUpdateMode, )
pub fn reflection_probe_set_intensity(&mut self, probe: Rid, intensity: f32)
pub fn reflection_probe_set_ambient_mode( &mut self, probe: Rid, mode: ReflectionProbeAmbientMode, )
pub fn reflection_probe_set_ambient_color(&mut self, probe: Rid, color: Color)
pub fn reflection_probe_set_ambient_energy(&mut self, probe: Rid, energy: f32)
pub fn reflection_probe_set_max_distance(&mut self, probe: Rid, distance: f32)
pub fn reflection_probe_set_size(&mut self, probe: Rid, size: Vector3)
pub fn reflection_probe_set_origin_offset( &mut self, probe: Rid, offset: Vector3, )
pub fn reflection_probe_set_as_interior(&mut self, probe: Rid, enable: bool)
pub fn reflection_probe_set_enable_box_projection( &mut self, probe: Rid, enable: bool, )
pub fn reflection_probe_set_enable_shadows(&mut self, probe: Rid, enable: bool)
pub fn reflection_probe_set_cull_mask(&mut self, probe: Rid, layers: u32)
pub fn reflection_probe_set_reflection_mask(&mut self, probe: Rid, layers: u32)
pub fn reflection_probe_set_resolution(&mut self, probe: Rid, resolution: i32)
pub fn reflection_probe_set_mesh_lod_threshold( &mut self, probe: Rid, pixels: f32, )
pub fn decal_create(&mut self) -> Rid
pub fn decal_set_size(&mut self, decal: Rid, size: Vector3)
pub fn decal_set_texture( &mut self, decal: Rid, type_: DecalTexture, texture: Rid, )
pub fn decal_set_emission_energy(&mut self, decal: Rid, energy: f32)
pub fn decal_set_albedo_mix(&mut self, decal: Rid, albedo_mix: f32)
pub fn decal_set_modulate(&mut self, decal: Rid, color: Color)
pub fn decal_set_cull_mask(&mut self, decal: Rid, mask: u32)
pub fn decal_set_distance_fade( &mut self, decal: Rid, enabled: bool, begin: f32, length: f32, )
pub fn decal_set_fade(&mut self, decal: Rid, above: f32, below: f32)
pub fn decal_set_normal_fade(&mut self, decal: Rid, fade: f32)
pub fn decals_set_filter(&mut self, filter: DecalFilter)
pub fn gi_set_use_half_resolution(&mut self, half_resolution: bool)
pub fn voxel_gi_create(&mut self) -> Rid
pub fn voxel_gi_allocate_data( &mut self, voxel_gi: Rid, to_cell_xform: Transform3D, aabb: Aabb, octree_size: Vector3i, octree_cells: &PackedByteArray, data_cells: &PackedByteArray, distance_field: &PackedByteArray, level_counts: &PackedInt32Array, )
pub fn voxel_gi_get_octree_size(&self, voxel_gi: Rid) -> Vector3i
pub fn voxel_gi_get_octree_cells(&self, voxel_gi: Rid) -> PackedByteArray
pub fn voxel_gi_get_data_cells(&self, voxel_gi: Rid) -> PackedByteArray
pub fn voxel_gi_get_distance_field(&self, voxel_gi: Rid) -> PackedByteArray
pub fn voxel_gi_get_level_counts(&self, voxel_gi: Rid) -> PackedInt32Array
pub fn voxel_gi_get_to_cell_xform(&self, voxel_gi: Rid) -> Transform3D
pub fn voxel_gi_set_dynamic_range(&mut self, voxel_gi: Rid, range: f32)
pub fn voxel_gi_set_propagation(&mut self, voxel_gi: Rid, amount: f32)
pub fn voxel_gi_set_energy(&mut self, voxel_gi: Rid, energy: f32)
pub fn voxel_gi_set_baked_exposure_normalization( &mut self, voxel_gi: Rid, baked_exposure: f32, )
pub fn voxel_gi_set_bias(&mut self, voxel_gi: Rid, bias: f32)
pub fn voxel_gi_set_normal_bias(&mut self, voxel_gi: Rid, bias: f32)
pub fn voxel_gi_set_interior(&mut self, voxel_gi: Rid, enable: bool)
pub fn voxel_gi_set_use_two_bounces(&mut self, voxel_gi: Rid, enable: bool)
pub fn voxel_gi_set_quality(&mut self, quality: VoxelGiQuality)
pub fn lightmap_create(&mut self) -> Rid
pub fn lightmap_set_textures( &mut self, lightmap: Rid, light: Rid, uses_sh: bool, )
pub fn lightmap_set_probe_bounds(&mut self, lightmap: Rid, bounds: Aabb)
pub fn lightmap_set_probe_interior(&mut self, lightmap: Rid, interior: bool)
pub fn lightmap_set_probe_capture_data( &mut self, lightmap: Rid, points: &PackedVector3Array, point_sh: &PackedColorArray, tetrahedra: &PackedInt32Array, bsp_tree: &PackedInt32Array, )
pub fn lightmap_get_probe_capture_points( &self, lightmap: Rid, ) -> PackedVector3Array
pub fn lightmap_get_probe_capture_sh(&self, lightmap: Rid) -> PackedColorArray
pub fn lightmap_get_probe_capture_tetrahedra( &self, lightmap: Rid, ) -> PackedInt32Array
pub fn lightmap_get_probe_capture_bsp_tree( &self, lightmap: Rid, ) -> PackedInt32Array
pub fn lightmap_set_baked_exposure_normalization( &mut self, lightmap: Rid, baked_exposure: f32, )
pub fn lightmap_set_probe_capture_update_speed(&mut self, speed: f32)
pub fn particles_create(&mut self) -> Rid
pub fn particles_set_mode(&mut self, particles: Rid, mode: ParticlesMode)
pub fn particles_set_emitting(&mut self, particles: Rid, emitting: bool)
pub fn particles_get_emitting(&mut self, particles: Rid) -> bool
pub fn particles_set_amount(&mut self, particles: Rid, amount: i32)
pub fn particles_set_amount_ratio(&mut self, particles: Rid, ratio: f32)
pub fn particles_set_lifetime(&mut self, particles: Rid, lifetime: f64)
pub fn particles_set_one_shot(&mut self, particles: Rid, one_shot: bool)
pub fn particles_set_pre_process_time(&mut self, particles: Rid, time: f64)
pub fn particles_set_explosiveness_ratio(&mut self, particles: Rid, ratio: f32)
pub fn particles_set_randomness_ratio(&mut self, particles: Rid, ratio: f32)
pub fn particles_set_interp_to_end(&mut self, particles: Rid, factor: f32)
pub fn particles_set_emitter_velocity( &mut self, particles: Rid, velocity: Vector3, )
pub fn particles_set_custom_aabb(&mut self, particles: Rid, aabb: Aabb)
pub fn particles_set_speed_scale(&mut self, particles: Rid, scale: f64)
pub fn particles_set_use_local_coordinates( &mut self, particles: Rid, enable: bool, )
pub fn particles_set_process_material(&mut self, particles: Rid, material: Rid)
pub fn particles_set_fixed_fps(&mut self, particles: Rid, fps: i32)
pub fn particles_set_interpolate(&mut self, particles: Rid, enable: bool)
pub fn particles_set_fractional_delta(&mut self, particles: Rid, enable: bool)
pub fn particles_set_collision_base_size(&mut self, particles: Rid, size: f32)
pub fn particles_set_transform_align( &mut self, particles: Rid, align: ParticlesTransformAlign, )
pub fn particles_set_trails( &mut self, particles: Rid, enable: bool, length_sec: f32, )
pub fn particles_set_trail_bind_poses( &mut self, particles: Rid, bind_poses: &Array<Transform3D>, )
pub fn particles_is_inactive(&mut self, particles: Rid) -> bool
pub fn particles_request_process(&mut self, particles: Rid)
pub fn particles_restart(&mut self, particles: Rid)
pub fn particles_set_subemitter( &mut self, particles: Rid, subemitter_particles: Rid, )
pub fn particles_emit( &mut self, particles: Rid, transform: Transform3D, velocity: Vector3, color: Color, custom: Color, emit_flags: u32, )
pub fn particles_set_draw_order( &mut self, particles: Rid, order: ParticlesDrawOrder, )
pub fn particles_set_draw_passes(&mut self, particles: Rid, count: i32)
pub fn particles_set_draw_pass_mesh( &mut self, particles: Rid, pass: i32, mesh: Rid, )
pub fn particles_get_current_aabb(&mut self, particles: Rid) -> Aabb
pub fn particles_set_emission_transform( &mut self, particles: Rid, transform: Transform3D, )
pub fn particles_collision_create(&mut self) -> Rid
pub fn particles_collision_set_collision_type( &mut self, particles_collision: Rid, type_: ParticlesCollisionType, )
pub fn particles_collision_set_cull_mask( &mut self, particles_collision: Rid, mask: u32, )
pub fn particles_collision_set_sphere_radius( &mut self, particles_collision: Rid, radius: f32, )
pub fn particles_collision_set_box_extents( &mut self, particles_collision: Rid, extents: Vector3, )
pub fn particles_collision_set_attractor_strength( &mut self, particles_collision: Rid, strength: f32, )
pub fn particles_collision_set_attractor_directionality( &mut self, particles_collision: Rid, amount: f32, )
pub fn particles_collision_set_attractor_attenuation( &mut self, particles_collision: Rid, curve: f32, )
pub fn particles_collision_set_field_texture( &mut self, particles_collision: Rid, texture: Rid, )
pub fn particles_collision_height_field_update( &mut self, particles_collision: Rid, )
pub fn particles_collision_set_height_field_resolution( &mut self, particles_collision: Rid, resolution: ParticlesCollisionHeightfieldResolution, )
pub fn fog_volume_create(&mut self) -> Rid
pub fn fog_volume_set_shape(&mut self, fog_volume: Rid, shape: FogVolumeShape)
pub fn fog_volume_set_size(&mut self, fog_volume: Rid, size: Vector3)
pub fn fog_volume_set_material(&mut self, fog_volume: Rid, material: Rid)
pub fn visibility_notifier_create(&mut self) -> Rid
pub fn visibility_notifier_set_aabb(&mut self, notifier: Rid, aabb: Aabb)
pub fn visibility_notifier_set_callbacks( &mut self, notifier: Rid, enter_callable: Callable, exit_callable: Callable, )
pub fn occluder_create(&mut self) -> Rid
pub fn occluder_set_mesh( &mut self, occluder: Rid, vertices: &PackedVector3Array, indices: &PackedInt32Array, )
pub fn camera_create(&mut self) -> Rid
pub fn camera_set_perspective( &mut self, camera: Rid, fovy_degrees: f32, z_near: f32, z_far: f32, )
pub fn camera_set_orthogonal( &mut self, camera: Rid, size: f32, z_near: f32, z_far: f32, )
pub fn camera_set_frustum( &mut self, camera: Rid, size: f32, offset: Vector2, z_near: f32, z_far: f32, )
pub fn camera_set_transform(&mut self, camera: Rid, transform: Transform3D)
pub fn camera_set_cull_mask(&mut self, camera: Rid, layers: u32)
pub fn camera_set_environment(&mut self, camera: Rid, env: Rid)
pub fn camera_set_camera_attributes(&mut self, camera: Rid, effects: Rid)
pub fn camera_set_compositor(&mut self, camera: Rid, compositor: Rid)
pub fn camera_set_use_vertical_aspect(&mut self, camera: Rid, enable: bool)
pub fn viewport_create(&mut self) -> Rid
pub fn viewport_set_use_xr(&mut self, viewport: Rid, use_xr: bool)
pub fn viewport_set_size(&mut self, viewport: Rid, width: i32, height: i32)
pub fn viewport_set_active(&mut self, viewport: Rid, active: bool)
pub fn viewport_set_parent_viewport( &mut self, viewport: Rid, parent_viewport: Rid, )
pub fn viewport_attach_to_screen(&mut self, viewport: Rid)
pub fn viewport_attach_to_screen(&mut self, viewport: Rid)
To set the default parameters, use Self::viewport_attach_to_screen_ex
and its builder methods. See the book for detailed usage instructions.
pub fn viewport_attach_to_screen_ex<'a>( &'a mut self, viewport: Rid, ) -> ExViewportAttachToScreen<'a>
pub fn viewport_set_render_direct_to_screen( &mut self, viewport: Rid, enabled: bool, )
pub fn viewport_set_canvas_cull_mask( &mut self, viewport: Rid, canvas_cull_mask: u32, )
pub fn viewport_set_scaling_3d_mode( &mut self, viewport: Rid, scaling_3d_mode: ViewportScaling3DMode, )
pub fn viewport_set_scaling_3d_scale(&mut self, viewport: Rid, scale: f32)
pub fn viewport_set_fsr_sharpness(&mut self, viewport: Rid, sharpness: f32)
pub fn viewport_set_texture_mipmap_bias( &mut self, viewport: Rid, mipmap_bias: f32, )
pub fn viewport_set_update_mode( &mut self, viewport: Rid, update_mode: ViewportUpdateMode, )
pub fn viewport_get_update_mode(&self, viewport: Rid) -> ViewportUpdateMode
pub fn viewport_set_clear_mode( &mut self, viewport: Rid, clear_mode: ViewportClearMode, )
pub fn viewport_get_render_target(&self, viewport: Rid) -> Rid
pub fn viewport_get_texture(&self, viewport: Rid) -> Rid
pub fn viewport_set_disable_3d(&mut self, viewport: Rid, disable: bool)
pub fn viewport_set_disable_2d(&mut self, viewport: Rid, disable: bool)
pub fn viewport_set_environment_mode( &mut self, viewport: Rid, mode: ViewportEnvironmentMode, )
pub fn viewport_attach_camera(&mut self, viewport: Rid, camera: Rid)
pub fn viewport_set_scenario(&mut self, viewport: Rid, scenario: Rid)
pub fn viewport_attach_canvas(&mut self, viewport: Rid, canvas: Rid)
pub fn viewport_remove_canvas(&mut self, viewport: Rid, canvas: Rid)
pub fn viewport_set_snap_2d_transforms_to_pixel( &mut self, viewport: Rid, enabled: bool, )
pub fn viewport_set_snap_2d_vertices_to_pixel( &mut self, viewport: Rid, enabled: bool, )
pub fn viewport_set_default_canvas_item_texture_filter( &mut self, viewport: Rid, filter: CanvasItemTextureFilter, )
pub fn viewport_set_default_canvas_item_texture_repeat( &mut self, viewport: Rid, repeat: CanvasItemTextureRepeat, )
pub fn viewport_set_canvas_transform( &mut self, viewport: Rid, canvas: Rid, offset: Transform2D, )
pub fn viewport_set_canvas_stacking( &mut self, viewport: Rid, canvas: Rid, layer: i32, sublayer: i32, )
pub fn viewport_set_transparent_background( &mut self, viewport: Rid, enabled: bool, )
pub fn viewport_set_global_canvas_transform( &mut self, viewport: Rid, transform: Transform2D, )
pub fn viewport_set_sdf_oversize_and_scale( &mut self, viewport: Rid, oversize: ViewportSdfOversize, scale: ViewportSdfScale, )
pub fn viewport_set_positional_shadow_atlas_size(
&mut self,
viewport: Rid,
size: i32,
)
pub fn viewport_set_positional_shadow_atlas_size( &mut self, viewport: Rid, size: i32, )
To set the default parameters, use Self::viewport_set_positional_shadow_atlas_size_ex
and its builder methods. See the book for detailed usage instructions.
pub fn viewport_set_positional_shadow_atlas_size_ex<'a>( &'a mut self, viewport: Rid, size: i32, ) -> ExViewportSetPositionalShadowAtlasSize<'a>
pub fn viewport_set_positional_shadow_atlas_quadrant_subdivision( &mut self, viewport: Rid, quadrant: i32, subdivision: i32, )
pub fn viewport_set_msaa_3d(&mut self, viewport: Rid, msaa: ViewportMsaa)
pub fn viewport_set_msaa_2d(&mut self, viewport: Rid, msaa: ViewportMsaa)
pub fn viewport_set_use_hdr_2d(&mut self, viewport: Rid, enabled: bool)
pub fn viewport_set_screen_space_aa( &mut self, viewport: Rid, mode: ViewportScreenSpaceAa, )
pub fn viewport_set_use_taa(&mut self, viewport: Rid, enable: bool)
pub fn viewport_set_use_debanding(&mut self, viewport: Rid, enable: bool)
pub fn viewport_set_use_occlusion_culling( &mut self, viewport: Rid, enable: bool, )
pub fn viewport_set_occlusion_rays_per_thread(&mut self, rays_per_thread: i32)
pub fn viewport_set_occlusion_culling_build_quality( &mut self, quality: ViewportOcclusionCullingBuildQuality, )
pub fn viewport_get_render_info( &mut self, viewport: Rid, type_: ViewportRenderInfoType, info: ViewportRenderInfo, ) -> i32
pub fn viewport_set_debug_draw( &mut self, viewport: Rid, draw: ViewportDebugDraw, )
pub fn viewport_set_measure_render_time(&mut self, viewport: Rid, enable: bool)
pub fn viewport_get_measured_render_time_cpu(&self, viewport: Rid) -> f64
pub fn viewport_get_measured_render_time_gpu(&self, viewport: Rid) -> f64
pub fn viewport_set_vrs_mode(&mut self, viewport: Rid, mode: ViewportVrsMode)
pub fn viewport_set_vrs_update_mode( &mut self, viewport: Rid, mode: ViewportVrsUpdateMode, )
pub fn viewport_set_vrs_texture(&mut self, viewport: Rid, texture: Rid)
pub fn sky_create(&mut self) -> Rid
pub fn sky_set_radiance_size(&mut self, sky: Rid, radiance_size: i32)
pub fn sky_set_mode(&mut self, sky: Rid, mode: SkyMode)
pub fn sky_set_material(&mut self, sky: Rid, material: Rid)
pub fn sky_bake_panorama( &mut self, sky: Rid, energy: f32, bake_irradiance: bool, size: Vector2i, ) -> Option<Gd<Image>>
pub fn compositor_effect_create(&mut self) -> Rid
pub fn compositor_effect_set_enabled(&mut self, effect: Rid, enabled: bool)
pub fn compositor_effect_set_callback( &mut self, effect: Rid, callback_type: CompositorEffectCallbackType, callback: Callable, )
pub fn compositor_effect_set_flag( &mut self, effect: Rid, flag: CompositorEffectFlags, set: bool, )
pub fn compositor_create(&mut self) -> Rid
pub fn compositor_set_compositor_effects( &mut self, compositor: Rid, effects: &Array<Rid>, )
pub fn environment_create(&mut self) -> Rid
pub fn environment_set_background(&mut self, env: Rid, bg: EnvironmentBg)
pub fn environment_set_sky(&mut self, env: Rid, sky: Rid)
pub fn environment_set_sky_custom_fov(&mut self, env: Rid, scale: f32)
pub fn environment_set_sky_orientation(&mut self, env: Rid, orientation: Basis)
pub fn environment_set_bg_color(&mut self, env: Rid, color: Color)
pub fn environment_set_bg_energy( &mut self, env: Rid, multiplier: f32, exposure_value: f32, )
pub fn environment_set_canvas_max_layer(&mut self, env: Rid, max_layer: i32)
pub fn environment_set_ambient_light(&mut self, env: Rid, color: Color)
pub fn environment_set_ambient_light(&mut self, env: Rid, color: Color)
To set the default parameters, use Self::environment_set_ambient_light_ex
and its builder methods. See the book for detailed usage instructions.
pub fn environment_set_ambient_light_ex<'a>( &'a mut self, env: Rid, color: Color, ) -> ExEnvironmentSetAmbientLight<'a>
pub fn environment_set_glow( &mut self, env: Rid, enable: bool, levels: &PackedFloat32Array, intensity: f32, strength: f32, mix: f32, bloom_threshold: f32, blend_mode: EnvironmentGlowBlendMode, hdr_bleed_threshold: f32, hdr_bleed_scale: f32, hdr_luminance_cap: f32, glow_map_strength: f32, glow_map: Rid, )
pub fn environment_set_tonemap( &mut self, env: Rid, tone_mapper: EnvironmentToneMapper, exposure: f32, white: f32, )
pub fn environment_set_adjustment( &mut self, env: Rid, enable: bool, brightness: f32, contrast: f32, saturation: f32, use_1d_color_correction: bool, color_correction: Rid, )
pub fn environment_set_ssr( &mut self, env: Rid, enable: bool, max_steps: i32, fade_in: f32, fade_out: f32, depth_tolerance: f32, )
pub fn environment_set_ssao( &mut self, env: Rid, enable: bool, radius: f32, intensity: f32, power: f32, detail: f32, horizon: f32, sharpness: f32, light_affect: f32, ao_channel_affect: f32, )
pub fn environment_set_fog(
&mut self,
env: Rid,
enable: bool,
light_color: Color,
light_energy: f32,
sun_scatter: f32,
density: f32,
height: f32,
height_density: f32,
aerial_perspective: f32,
sky_affect: f32,
)
pub fn environment_set_fog( &mut self, env: Rid, enable: bool, light_color: Color, light_energy: f32, sun_scatter: f32, density: f32, height: f32, height_density: f32, aerial_perspective: f32, sky_affect: f32, )
To set the default parameters, use Self::environment_set_fog_ex
and its builder methods. See the book for detailed usage instructions.
pub fn environment_set_fog_ex<'a>( &'a mut self, env: Rid, enable: bool, light_color: Color, light_energy: f32, sun_scatter: f32, density: f32, height: f32, height_density: f32, aerial_perspective: f32, sky_affect: f32, ) -> ExEnvironmentSetFog<'a>
pub fn environment_set_sdfgi( &mut self, env: Rid, enable: bool, cascades: i32, min_cell_size: f32, y_scale: EnvironmentSdfgiYScale, use_occlusion: bool, bounce_feedback: f32, read_sky: bool, energy: f32, normal_bias: f32, probe_bias: f32, )
pub fn environment_set_volumetric_fog( &mut self, env: Rid, enable: bool, density: f32, albedo: Color, emission: Color, emission_energy: f32, anisotropy: f32, length: f32, p_detail_spread: f32, gi_inject: f32, temporal_reprojection: bool, temporal_reprojection_amount: f32, ambient_inject: f32, sky_affect: f32, )
pub fn environment_glow_set_use_bicubic_upscale(&mut self, enable: bool)
pub fn environment_set_ssr_roughness_quality( &mut self, quality: EnvironmentSsrRoughnessQuality, )
pub fn environment_set_ssao_quality( &mut self, quality: EnvironmentSsaoQuality, half_size: bool, adaptive_target: f32, blur_passes: i32, fadeout_from: f32, fadeout_to: f32, )
pub fn environment_set_ssil_quality( &mut self, quality: EnvironmentSsilQuality, half_size: bool, adaptive_target: f32, blur_passes: i32, fadeout_from: f32, fadeout_to: f32, )
pub fn environment_set_sdfgi_ray_count( &mut self, ray_count: EnvironmentSdfgiRayCount, )
pub fn environment_set_sdfgi_frames_to_converge( &mut self, frames: EnvironmentSdfgiFramesToConverge, )
pub fn environment_set_sdfgi_frames_to_update_light( &mut self, frames: EnvironmentSdfgiFramesToUpdateLight, )
pub fn environment_set_volumetric_fog_volume_size( &mut self, size: i32, depth: i32, )
pub fn environment_set_volumetric_fog_filter_active(&mut self, active: bool)
pub fn environment_bake_panorama( &mut self, environment: Rid, bake_irradiance: bool, size: Vector2i, ) -> Option<Gd<Image>>
pub fn screen_space_roughness_limiter_set_active( &mut self, enable: bool, amount: f32, limit: f32, )
pub fn sub_surface_scattering_set_quality( &mut self, quality: SubSurfaceScatteringQuality, )
pub fn sub_surface_scattering_set_scale(&mut self, scale: f32, depth_scale: f32)
pub fn camera_attributes_create(&mut self) -> Rid
pub fn camera_attributes_set_dof_blur_quality( &mut self, quality: DofBlurQuality, use_jitter: bool, )
pub fn camera_attributes_set_dof_blur_bokeh_shape( &mut self, shape: DofBokehShape, )
pub fn camera_attributes_set_dof_blur( &mut self, camera_attributes: Rid, far_enable: bool, far_distance: f32, far_transition: f32, near_enable: bool, near_distance: f32, near_transition: f32, amount: f32, )
pub fn camera_attributes_set_exposure( &mut self, camera_attributes: Rid, multiplier: f32, normalization: f32, )
pub fn camera_attributes_set_auto_exposure( &mut self, camera_attributes: Rid, enable: bool, min_sensitivity: f32, max_sensitivity: f32, speed: f32, scale: f32, )
pub fn scenario_create(&mut self) -> Rid
pub fn scenario_set_environment(&mut self, scenario: Rid, environment: Rid)
pub fn scenario_set_fallback_environment( &mut self, scenario: Rid, environment: Rid, )
pub fn scenario_set_camera_attributes(&mut self, scenario: Rid, effects: Rid)
pub fn scenario_set_compositor(&mut self, scenario: Rid, compositor: Rid)
pub fn instance_create2(&mut self, base: Rid, scenario: Rid) -> Rid
pub fn instance_create(&mut self) -> Rid
pub fn instance_set_base(&mut self, instance: Rid, base: Rid)
pub fn instance_set_scenario(&mut self, instance: Rid, scenario: Rid)
pub fn instance_set_layer_mask(&mut self, instance: Rid, mask: u32)
pub fn instance_set_pivot_data( &mut self, instance: Rid, sorting_offset: f32, use_aabb_center: bool, )
pub fn instance_set_transform(&mut self, instance: Rid, transform: Transform3D)
pub fn instance_attach_object_instance_id(&mut self, instance: Rid, id: u64)
pub fn instance_set_blend_shape_weight( &mut self, instance: Rid, shape: i32, weight: f32, )
pub fn instance_set_surface_override_material( &mut self, instance: Rid, surface: i32, material: Rid, )
pub fn instance_set_visible(&mut self, instance: Rid, visible: bool)
pub fn instance_geometry_set_transparency( &mut self, instance: Rid, transparency: f32, )
pub fn instance_set_custom_aabb(&mut self, instance: Rid, aabb: Aabb)
pub fn instance_attach_skeleton(&mut self, instance: Rid, skeleton: Rid)
pub fn instance_set_extra_visibility_margin( &mut self, instance: Rid, margin: f32, )
pub fn instance_set_visibility_parent(&mut self, instance: Rid, parent: Rid)
pub fn instance_set_ignore_culling(&mut self, instance: Rid, enabled: bool)
pub fn instance_geometry_set_flag( &mut self, instance: Rid, flag: InstanceFlags, enabled: bool, )
pub fn instance_geometry_set_cast_shadows_setting( &mut self, instance: Rid, shadow_casting_setting: ShadowCastingSetting, )
pub fn instance_geometry_set_material_override( &mut self, instance: Rid, material: Rid, )
pub fn instance_geometry_set_material_overlay( &mut self, instance: Rid, material: Rid, )
pub fn instance_geometry_set_visibility_range( &mut self, instance: Rid, min: f32, max: f32, min_margin: f32, max_margin: f32, fade_mode: VisibilityRangeFadeMode, )
pub fn instance_geometry_set_lightmap( &mut self, instance: Rid, lightmap: Rid, lightmap_uv_scale: Rect2, lightmap_slice: i32, )
pub fn instance_geometry_set_lod_bias(&mut self, instance: Rid, lod_bias: f32)
pub fn instance_geometry_set_shader_parameter( &mut self, instance: Rid, parameter: StringName, value: &Variant, )
pub fn instance_geometry_get_shader_parameter( &self, instance: Rid, parameter: StringName, ) -> Variant
pub fn instance_geometry_get_shader_parameter_default_value( &self, instance: Rid, parameter: StringName, ) -> Variant
pub fn instance_geometry_get_shader_parameter_list( &self, instance: Rid, ) -> Array<Dictionary>
pub fn instances_cull_aabb(&self, aabb: Aabb) -> PackedInt64Array
pub fn instances_cull_aabb(&self, aabb: Aabb) -> PackedInt64Array
To set the default parameters, use Self::instances_cull_aabb_ex
and its builder methods. See the book for detailed usage instructions.
pub fn instances_cull_aabb_ex<'a>( &'a self, aabb: Aabb, ) -> ExInstancesCullAabb<'a>
pub fn instances_cull_ray(&self, from: Vector3, to: Vector3) -> PackedInt64Array
pub fn instances_cull_ray(&self, from: Vector3, to: Vector3) -> PackedInt64Array
To set the default parameters, use Self::instances_cull_ray_ex
and its builder methods. See the book for detailed usage instructions.
pub fn instances_cull_ray_ex<'a>( &'a self, from: Vector3, to: Vector3, ) -> ExInstancesCullRay<'a>
pub fn instances_cull_convex<'a>(
&self,
convex: &'a Array<Plane>,
) -> PackedInt64Array
pub fn instances_cull_convex<'a>( &self, convex: &'a Array<Plane>, ) -> PackedInt64Array
To set the default parameters, use Self::instances_cull_convex_ex
and its builder methods. See the book for detailed usage instructions.
pub fn instances_cull_convex_ex<'a>( &'a self, convex: &'a Array<Plane>, ) -> ExInstancesCullConvex<'a>
pub fn bake_render_uv2( &mut self, base: Rid, material_overrides: &Array<Rid>, image_size: Vector2i, ) -> Array<Gd<Image>>
pub fn canvas_create(&mut self) -> Rid
pub fn canvas_set_item_mirroring( &mut self, canvas: Rid, item: Rid, mirroring: Vector2, )
pub fn canvas_set_item_repeat( &mut self, item: Rid, repeat_size: Vector2, repeat_times: i32, )
pub fn canvas_set_modulate(&mut self, canvas: Rid, color: Color)
pub fn canvas_set_disable_scale(&mut self, disable: bool)
pub fn canvas_texture_create(&mut self) -> Rid
pub fn canvas_texture_set_channel( &mut self, canvas_texture: Rid, channel: CanvasTextureChannel, texture: Rid, )
pub fn canvas_texture_set_shading_parameters( &mut self, canvas_texture: Rid, base_color: Color, shininess: f32, )
pub fn canvas_texture_set_texture_filter( &mut self, canvas_texture: Rid, filter: CanvasItemTextureFilter, )
pub fn canvas_texture_set_texture_repeat( &mut self, canvas_texture: Rid, repeat: CanvasItemTextureRepeat, )
pub fn canvas_item_create(&mut self) -> Rid
pub fn canvas_item_set_parent(&mut self, item: Rid, parent: Rid)
pub fn canvas_item_set_default_texture_filter( &mut self, item: Rid, filter: CanvasItemTextureFilter, )
pub fn canvas_item_set_default_texture_repeat( &mut self, item: Rid, repeat: CanvasItemTextureRepeat, )
pub fn canvas_item_set_visible(&mut self, item: Rid, visible: bool)
pub fn canvas_item_set_light_mask(&mut self, item: Rid, mask: i32)
pub fn canvas_item_set_visibility_layer( &mut self, item: Rid, visibility_layer: u32, )
pub fn canvas_item_set_transform(&mut self, item: Rid, transform: Transform2D)
pub fn canvas_item_set_clip(&mut self, item: Rid, clip: bool)
pub fn canvas_item_set_distance_field_mode(&mut self, item: Rid, enabled: bool)
pub fn canvas_item_set_custom_rect(&mut self, item: Rid, use_custom_rect: bool)
pub fn canvas_item_set_custom_rect(&mut self, item: Rid, use_custom_rect: bool)
To set the default parameters, use Self::canvas_item_set_custom_rect_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_set_custom_rect_ex<'a>( &'a mut self, item: Rid, use_custom_rect: bool, ) -> ExCanvasItemSetCustomRect<'a>
pub fn canvas_item_set_modulate(&mut self, item: Rid, color: Color)
pub fn canvas_item_set_self_modulate(&mut self, item: Rid, color: Color)
pub fn canvas_item_set_draw_behind_parent(&mut self, item: Rid, enabled: bool)
pub fn canvas_item_set_interpolated(&mut self, item: Rid, interpolated: bool)
pub fn canvas_item_reset_physics_interpolation(&mut self, item: Rid)
pub fn canvas_item_transform_physics_interpolation( &mut self, item: Rid, transform: Transform2D, )
pub fn canvas_item_add_line(
&mut self,
item: Rid,
from: Vector2,
to: Vector2,
color: Color,
)
pub fn canvas_item_add_line( &mut self, item: Rid, from: Vector2, to: Vector2, color: Color, )
To set the default parameters, use Self::canvas_item_add_line_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_line_ex<'a>( &'a mut self, item: Rid, from: Vector2, to: Vector2, color: Color, ) -> ExCanvasItemAddLine<'a>
pub fn canvas_item_add_polyline<'a>(
&mut self,
item: Rid,
points: &'a PackedVector2Array,
colors: &'a PackedColorArray,
)
pub fn canvas_item_add_polyline<'a>( &mut self, item: Rid, points: &'a PackedVector2Array, colors: &'a PackedColorArray, )
To set the default parameters, use Self::canvas_item_add_polyline_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_polyline_ex<'a>( &'a mut self, item: Rid, points: &'a PackedVector2Array, colors: &'a PackedColorArray, ) -> ExCanvasItemAddPolyline<'a>
pub fn canvas_item_add_multiline<'a>(
&mut self,
item: Rid,
points: &'a PackedVector2Array,
colors: &'a PackedColorArray,
)
pub fn canvas_item_add_multiline<'a>( &mut self, item: Rid, points: &'a PackedVector2Array, colors: &'a PackedColorArray, )
To set the default parameters, use Self::canvas_item_add_multiline_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_multiline_ex<'a>( &'a mut self, item: Rid, points: &'a PackedVector2Array, colors: &'a PackedColorArray, ) -> ExCanvasItemAddMultiline<'a>
pub fn canvas_item_add_rect(&mut self, item: Rid, rect: Rect2, color: Color)
pub fn canvas_item_add_rect(&mut self, item: Rid, rect: Rect2, color: Color)
To set the default parameters, use Self::canvas_item_add_rect_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_rect_ex<'a>( &'a mut self, item: Rid, rect: Rect2, color: Color, ) -> ExCanvasItemAddRect<'a>
pub fn canvas_item_add_circle(
&mut self,
item: Rid,
pos: Vector2,
radius: f32,
color: Color,
)
pub fn canvas_item_add_circle( &mut self, item: Rid, pos: Vector2, radius: f32, color: Color, )
To set the default parameters, use Self::canvas_item_add_circle_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_circle_ex<'a>( &'a mut self, item: Rid, pos: Vector2, radius: f32, color: Color, ) -> ExCanvasItemAddCircle<'a>
pub fn canvas_item_add_texture_rect(
&mut self,
item: Rid,
rect: Rect2,
texture: Rid,
)
pub fn canvas_item_add_texture_rect( &mut self, item: Rid, rect: Rect2, texture: Rid, )
To set the default parameters, use Self::canvas_item_add_texture_rect_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_texture_rect_ex<'a>( &'a mut self, item: Rid, rect: Rect2, texture: Rid, ) -> ExCanvasItemAddTextureRect<'a>
pub fn canvas_item_add_msdf_texture_rect_region(
&mut self,
item: Rid,
rect: Rect2,
texture: Rid,
src_rect: Rect2,
)
pub fn canvas_item_add_msdf_texture_rect_region( &mut self, item: Rid, rect: Rect2, texture: Rid, src_rect: Rect2, )
To set the default parameters, use Self::canvas_item_add_msdf_texture_rect_region_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_msdf_texture_rect_region_ex<'a>( &'a mut self, item: Rid, rect: Rect2, texture: Rid, src_rect: Rect2, ) -> ExCanvasItemAddMsdfTextureRectRegion<'a>
pub fn canvas_item_add_lcd_texture_rect_region( &mut self, item: Rid, rect: Rect2, texture: Rid, src_rect: Rect2, modulate: Color, )
pub fn canvas_item_add_texture_rect_region(
&mut self,
item: Rid,
rect: Rect2,
texture: Rid,
src_rect: Rect2,
)
pub fn canvas_item_add_texture_rect_region( &mut self, item: Rid, rect: Rect2, texture: Rid, src_rect: Rect2, )
To set the default parameters, use Self::canvas_item_add_texture_rect_region_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_texture_rect_region_ex<'a>( &'a mut self, item: Rid, rect: Rect2, texture: Rid, src_rect: Rect2, ) -> ExCanvasItemAddTextureRectRegion<'a>
pub fn canvas_item_add_nine_patch(
&mut self,
item: Rid,
rect: Rect2,
source: Rect2,
texture: Rid,
topleft: Vector2,
bottomright: Vector2,
)
pub fn canvas_item_add_nine_patch( &mut self, item: Rid, rect: Rect2, source: Rect2, texture: Rid, topleft: Vector2, bottomright: Vector2, )
To set the default parameters, use Self::canvas_item_add_nine_patch_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_nine_patch_ex<'a>( &'a mut self, item: Rid, rect: Rect2, source: Rect2, texture: Rid, topleft: Vector2, bottomright: Vector2, ) -> ExCanvasItemAddNinePatch<'a>
pub fn canvas_item_add_primitive( &mut self, item: Rid, points: &PackedVector2Array, colors: &PackedColorArray, uvs: &PackedVector2Array, texture: Rid, )
pub fn canvas_item_add_polygon<'a>(
&mut self,
item: Rid,
points: &'a PackedVector2Array,
colors: &'a PackedColorArray,
)
pub fn canvas_item_add_polygon<'a>( &mut self, item: Rid, points: &'a PackedVector2Array, colors: &'a PackedColorArray, )
To set the default parameters, use Self::canvas_item_add_polygon_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_polygon_ex<'a>( &'a mut self, item: Rid, points: &'a PackedVector2Array, colors: &'a PackedColorArray, ) -> ExCanvasItemAddPolygon<'a>
pub fn canvas_item_add_triangle_array<'a>(
&mut self,
item: Rid,
indices: &'a PackedInt32Array,
points: &'a PackedVector2Array,
colors: &'a PackedColorArray,
)
pub fn canvas_item_add_triangle_array<'a>( &mut self, item: Rid, indices: &'a PackedInt32Array, points: &'a PackedVector2Array, colors: &'a PackedColorArray, )
To set the default parameters, use Self::canvas_item_add_triangle_array_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_triangle_array_ex<'a>( &'a mut self, item: Rid, indices: &'a PackedInt32Array, points: &'a PackedVector2Array, colors: &'a PackedColorArray, ) -> ExCanvasItemAddTriangleArray<'a>
pub fn canvas_item_add_mesh(&mut self, item: Rid, mesh: Rid)
pub fn canvas_item_add_mesh(&mut self, item: Rid, mesh: Rid)
To set the default parameters, use Self::canvas_item_add_mesh_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_mesh_ex<'a>( &'a mut self, item: Rid, mesh: Rid, ) -> ExCanvasItemAddMesh<'a>
pub fn canvas_item_add_multimesh(&mut self, item: Rid, mesh: Rid)
pub fn canvas_item_add_multimesh(&mut self, item: Rid, mesh: Rid)
To set the default parameters, use Self::canvas_item_add_multimesh_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_multimesh_ex<'a>( &'a mut self, item: Rid, mesh: Rid, ) -> ExCanvasItemAddMultimesh<'a>
pub fn canvas_item_add_particles( &mut self, item: Rid, particles: Rid, texture: Rid, )
pub fn canvas_item_add_set_transform( &mut self, item: Rid, transform: Transform2D, )
pub fn canvas_item_add_clip_ignore(&mut self, item: Rid, ignore: bool)
pub fn canvas_item_add_animation_slice(
&mut self,
item: Rid,
animation_length: f64,
slice_begin: f64,
slice_end: f64,
)
pub fn canvas_item_add_animation_slice( &mut self, item: Rid, animation_length: f64, slice_begin: f64, slice_end: f64, )
To set the default parameters, use Self::canvas_item_add_animation_slice_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_add_animation_slice_ex<'a>( &'a mut self, item: Rid, animation_length: f64, slice_begin: f64, slice_end: f64, ) -> ExCanvasItemAddAnimationSlice<'a>
pub fn canvas_item_set_sort_children_by_y(&mut self, item: Rid, enabled: bool)
pub fn canvas_item_set_z_index(&mut self, item: Rid, z_index: i32)
pub fn canvas_item_set_z_as_relative_to_parent( &mut self, item: Rid, enabled: bool, )
pub fn canvas_item_set_copy_to_backbuffer( &mut self, item: Rid, enabled: bool, rect: Rect2, )
pub fn canvas_item_clear(&mut self, item: Rid)
pub fn canvas_item_set_draw_index(&mut self, item: Rid, index: i32)
pub fn canvas_item_set_material(&mut self, item: Rid, material: Rid)
pub fn canvas_item_set_use_parent_material(&mut self, item: Rid, enabled: bool)
pub fn canvas_item_set_visibility_notifier( &mut self, item: Rid, enable: bool, area: Rect2, enter_callable: Callable, exit_callable: Callable, )
pub fn canvas_item_set_canvas_group_mode(
&mut self,
item: Rid,
mode: CanvasGroupMode,
)
pub fn canvas_item_set_canvas_group_mode( &mut self, item: Rid, mode: CanvasGroupMode, )
To set the default parameters, use Self::canvas_item_set_canvas_group_mode_ex
and its builder methods. See the book for detailed usage instructions.
pub fn canvas_item_set_canvas_group_mode_ex<'a>( &'a mut self, item: Rid, mode: CanvasGroupMode, ) -> ExCanvasItemSetCanvasGroupMode<'a>
pub fn debug_canvas_item_get_rect(&mut self, item: Rid) -> Rect2
pub fn canvas_light_create(&mut self) -> Rid
pub fn canvas_light_attach_to_canvas(&mut self, light: Rid, canvas: Rid)
pub fn canvas_light_set_enabled(&mut self, light: Rid, enabled: bool)
pub fn canvas_light_set_texture_scale(&mut self, light: Rid, scale: f32)
pub fn canvas_light_set_transform(&mut self, light: Rid, transform: Transform2D)
pub fn canvas_light_set_texture(&mut self, light: Rid, texture: Rid)
pub fn canvas_light_set_texture_offset(&mut self, light: Rid, offset: Vector2)
pub fn canvas_light_set_color(&mut self, light: Rid, color: Color)
pub fn canvas_light_set_height(&mut self, light: Rid, height: f32)
pub fn canvas_light_set_energy(&mut self, light: Rid, energy: f32)
pub fn canvas_light_set_z_range(&mut self, light: Rid, min_z: i32, max_z: i32)
pub fn canvas_light_set_layer_range( &mut self, light: Rid, min_layer: i32, max_layer: i32, )
pub fn canvas_light_set_item_cull_mask(&mut self, light: Rid, mask: i32)
pub fn canvas_light_set_item_shadow_cull_mask(&mut self, light: Rid, mask: i32)
pub fn canvas_light_set_mode(&mut self, light: Rid, mode: CanvasLightMode)
pub fn canvas_light_set_shadow_enabled(&mut self, light: Rid, enabled: bool)
pub fn canvas_light_set_shadow_filter( &mut self, light: Rid, filter: CanvasLightShadowFilter, )
pub fn canvas_light_set_shadow_color(&mut self, light: Rid, color: Color)
pub fn canvas_light_set_shadow_smooth(&mut self, light: Rid, smooth: f32)
pub fn canvas_light_set_blend_mode( &mut self, light: Rid, mode: CanvasLightBlendMode, )
pub fn canvas_light_set_interpolated(&mut self, light: Rid, interpolated: bool)
pub fn canvas_light_reset_physics_interpolation(&mut self, light: Rid)
pub fn canvas_light_transform_physics_interpolation( &mut self, light: Rid, transform: Transform2D, )
pub fn canvas_light_occluder_create(&mut self) -> Rid
pub fn canvas_light_occluder_attach_to_canvas( &mut self, occluder: Rid, canvas: Rid, )
pub fn canvas_light_occluder_set_enabled( &mut self, occluder: Rid, enabled: bool, )
pub fn canvas_light_occluder_set_polygon(&mut self, occluder: Rid, polygon: Rid)
pub fn canvas_light_occluder_set_as_sdf_collision( &mut self, occluder: Rid, enable: bool, )
pub fn canvas_light_occluder_set_transform( &mut self, occluder: Rid, transform: Transform2D, )
pub fn canvas_light_occluder_set_light_mask(&mut self, occluder: Rid, mask: i32)
pub fn canvas_light_occluder_set_interpolated( &mut self, occluder: Rid, interpolated: bool, )
pub fn canvas_light_occluder_reset_physics_interpolation( &mut self, occluder: Rid, )
pub fn canvas_light_occluder_transform_physics_interpolation( &mut self, occluder: Rid, transform: Transform2D, )
pub fn canvas_occluder_polygon_create(&mut self) -> Rid
pub fn canvas_occluder_polygon_set_shape( &mut self, occluder_polygon: Rid, shape: &PackedVector2Array, closed: bool, )
pub fn canvas_occluder_polygon_set_cull_mode( &mut self, occluder_polygon: Rid, mode: CanvasOccluderPolygonCullMode, )
pub fn canvas_set_shadow_texture_size(&mut self, size: i32)
pub fn global_shader_parameter_add( &mut self, name: StringName, type_: GlobalShaderParameterType, default_value: &Variant, )
pub fn global_shader_parameter_remove(&mut self, name: StringName)
pub fn global_shader_parameter_get_list(&self) -> Array<StringName>
pub fn global_shader_parameter_set(&mut self, name: StringName, value: &Variant)
pub fn global_shader_parameter_set_override( &mut self, name: StringName, value: &Variant, )
pub fn global_shader_parameter_get(&self, name: StringName) -> Variant
pub fn global_shader_parameter_get_type( &self, name: StringName, ) -> GlobalShaderParameterType
pub fn free_rid(&mut self, rid: Rid)
pub fn request_frame_drawn_callback(&mut self, callable: Callable)
pub fn has_changed(&self) -> bool
pub fn get_rendering_info(&mut self, info: RenderingInfo) -> u64
pub fn get_video_adapter_name(&self) -> GString
pub fn get_video_adapter_vendor(&self) -> GString
pub fn get_video_adapter_type(&self) -> DeviceType
pub fn get_video_adapter_api_version(&self) -> GString
pub fn make_sphere_mesh( &mut self, latitudes: i32, longitudes: i32, radius: f32, ) -> Rid
pub fn get_test_cube(&mut self) -> Rid
pub fn get_test_texture(&mut self) -> Rid
pub fn get_white_texture(&mut self) -> Rid
pub fn set_boot_image(
&mut self,
image: impl AsObjectArg<Image>,
color: Color,
scale: bool,
)
pub fn set_boot_image( &mut self, image: impl AsObjectArg<Image>, color: Color, scale: bool, )
To set the default parameters, use Self::set_boot_image_ex
and its builder methods. See the book for detailed usage instructions.
pub fn set_boot_image_ex<'a>( &'a mut self, image: impl AsObjectArg<Image>, color: Color, scale: bool, ) -> ExSetBootImage<'a>
pub fn get_default_clear_color(&mut self) -> Color
pub fn set_default_clear_color(&mut self, color: Color)
pub fn has_os_feature(&self, feature: GString) -> bool
pub fn set_debug_generate_wireframes(&mut self, generate: bool)
pub fn is_render_loop_enabled(&self) -> bool
pub fn set_render_loop_enabled(&mut self, enabled: bool)
pub fn get_frame_setup_time_cpu(&self) -> f64
pub fn force_sync(&mut self)
pub fn force_draw(&mut self)
pub fn force_draw(&mut self)
To set the default parameters, use Self::force_draw_ex
and its builder methods. See the book for detailed usage instructions.
pub fn force_draw_ex<'a>(&'a mut self) -> ExForceDraw<'a>
pub fn get_rendering_device(&self) -> Option<Gd<RenderingDevice>>
pub fn create_local_rendering_device(&self) -> Option<Gd<RenderingDevice>>
pub fn is_on_render_thread(&mut self) -> bool
pub fn call_on_render_thread(&mut self, callable: Callable)
pub fn has_feature(&self, feature: Features) -> bool
Methods from Deref<Target = Object>§
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: GString) -> bool
pub fn set(&mut self, property: StringName, value: &Variant)
pub fn get(&self, property: StringName) -> Variant
pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)
pub fn get_indexed(&self, property_path: NodePath) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: StringName) -> bool
pub fn property_get_revert(&self, property: StringName) -> Variant
pub fn set_script(&mut self, script: &Variant)
pub fn get_script(&self) -> Variant
pub fn set_meta(&mut self, name: StringName, value: &Variant)
pub fn remove_meta(&mut self, name: StringName)
pub fn get_meta(&self, name: StringName) -> Variant
pub fn get_meta(&self, name: StringName) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>
pub fn has_meta(&self, name: StringName) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: GString)
pub fn add_user_signal(&mut self, signal: GString)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: StringName) -> bool
pub fn remove_user_signal(&mut self, signal: StringName)
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: StringName,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred(&mut self, property: StringName, value: &Variant)
pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: StringName) -> bool
pub fn get_method_argument_count(&self, method: StringName) -> i32
pub fn has_signal(&self, signal: StringName) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
To set the default parameters, use Self::connect_ex
and its builder methods. See the book for detailed usage instructions.
pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>
pub fn disconnect(&mut self, signal: StringName, callable: Callable)
pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: StringName) -> GString
pub fn tr(&self, message: StringName) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>
pub fn tr_n(
&self,
message: StringName,
plural_message: StringName,
n: i32,
) -> GString
pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.