VisualServer Methods

Sets images to be rendered in the window margin.

Sets margin size, where black bars (or images, if BlackBarsSetImages(RID, RID, RID, RID) was used) are rendered.

Creates a camera and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all camera_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to CullMask.

Sets the environment used by this camera. Equivalent to Environment.

Sets camera to use frustum projection. This mode allows adjusting the offset argument to create "tilted frustum" effects.

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.

Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.

Sets Transform of camera.

If true, preserves the horizontal aspect ratio which is equivalent to . If false, preserves the vertical aspect ratio which is equivalent to .

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_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Adds a circle command to the CanvasItem's draw commands.

If ignore is true, the VisualServer does not perform clipping.

Adds a line command to the CanvasItem's draw commands.

Adds a mesh command to the CanvasItem's draw commands.

Adds a MultiMesh to the CanvasItem's draw commands. Only affects its aabb at the moment.

Adds a nine patch image to the CanvasItem's draw commands.

See NinePatchRect for more explanation.

Adds a particle system to the CanvasItem's draw commands.

Adds a polygon to the CanvasItem's draw commands.

Adds a polyline, which is a line from multiple points with a width, to the CanvasItem's draw commands.

Adds a primitive to the CanvasItem's draw commands.

Adds a rectangle to the CanvasItem's draw commands.

Adds a Transform2D command to the CanvasItem's draw commands.

This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item.

Adds a textured rect to the CanvasItem's draw commands.

Adds a texture rect with region setting to the CanvasItem's draw commands.

Adds a triangle array to the CanvasItem's draw commands.

Clears the CanvasItem and removes all commands in it.

Creates a new CanvasItem and returns its RID. It can be accessed with the RID that is returned. This RID will be used in all canvas_item_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Sets clipping for the CanvasItem.

Sets the CanvasItem to copy a rect to the backbuffer.

Defines a custom drawing rectangle for the CanvasItem.

Enables the use of distance fields for GUI elements that are rendering distance field based fonts.

Sets CanvasItem to be drawn behind its parent.

Sets the index for the CanvasItem.

The light mask. See LightOccluder2D for more information on light masks.

Sets a new material to the CanvasItem.

Sets the color that modulates the CanvasItem and its children.

Sets the parent for the CanvasItem. The parent can be another canvas item, or it can be the root canvas that is attached to the viewport.

Sets the color that modulates the CanvasItem without children.

Sets if CanvasItem's children should be sorted by y-position.

Sets the CanvasItem's Transform2D.

Sets if the CanvasItem uses its parent's material.

Sets if the canvas item (including its children) is visible.

If this is enabled, the Z index of the parent will be added to the children's Z index.

Sets the CanvasItem's Z index, i.e. its draw order (lower indexes are drawn first).

Attaches the canvas light to the canvas. Removes it from its previous canvas.

Creates a canvas light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_light_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Attaches a light occluder to the canvas. Removes it from its previous canvas.

Creates a light occluder and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_light_ocluder_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Enables or disables light occluder.

The light mask. See LightOccluder2D for more information on light masks.

Sets a light occluder's polygon.

Sets a light occluder's Transform2D.

Sets the color for a light.

Enables or disables a canvas light.

Sets a canvas light's energy.

Sets a canvas light's height.

The light mask. See LightOccluder2D for more information on light masks.

The binary mask used to determine which layers this canvas light's shadows affects. See LightOccluder2D for more information on light masks.

The layer range that gets rendered with this light.

The mode of the light, see VisualServerCanvasLightMode constants.

Sets the texture's scale factor of the light. Equivalent to TextureScale.

Sets the width of the shadow buffer, size gets scaled to the next power of two for this.

Sets the color of the canvas light's shadow.

Enables or disables the canvas light's shadow.

Sets the canvas light's shadow's filter, see VisualServerCanvasLightShadowFilter constants.

Sets the length of the shadow's gradient.

Smoothens the shadow. The lower, the smoother.

Sets texture to be used by light. Equivalent to Texture.

Sets the offset of the light's texture. Equivalent to Offset.

Sets the canvas light's Transform2D.

Sets the Z range of objects that will be affected by this light. Equivalent to RangeZMin and RangeZMax.

Creates a new light occluder polygon and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all canvas_occluder_polygon_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Sets an occluder polygons cull mode. See VisualServerCanvasOccluderPolygonCullMode constants.

Sets the shape of the occluder polygon.

Sets the shape of the occluder polygon as lines.

A copy of the canvas item will be drawn with a local offset of the mirroring Vector2.

Modulates all colors in the given canvas.

Creates a directional light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most light_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this directional light to an instance using InstanceSetBase(RID, RID) using the returned RID.

Draws a frame. This method is deprecated, please use ForceDraw(Boolean, Double) instead.

Creates an environment and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all environment_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Sets the values to be used with the "Adjustment" post-process effect. See Environment for more details.

Sets the ambient light parameters. See Environment for more details.

Sets the BGMode of the environment. Equivalent to BackgroundMode.

Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).

Sets the intensity of the background color.

Sets the maximum layer to use if using Canvas background mode.

Sets the values to be used with the "DoF Far Blur" post-process effect. See Environment for more details.

Sets the values to be used with the "DoF Near Blur" post-process effect. See Environment for more details.

Sets the variables to be used with the scene fog. See Environment for more details.

Sets the variables to be used with the fog depth effect. See Environment for more details.

Sets the variables to be used with the fog height effect. See Environment for more details.

Sets the variables to be used with the "glow" post-process effect. See Environment for more details.

Sets the Sky to be used as the environment's background when using BGMode sky. Equivalent to BackgroundSky.

Sets a custom field of view for the background Sky. Equivalent to BackgroundSkyCustomFov.

Sets the rotation of the background Sky expressed as a Basis. Equivalent to BackgroundSkyOrientation.

Sets the variables to be used with the "Screen Space Ambient Occlusion (SSAO)" post-process effect. See Environment for more details.

Sets the variables to be used with the "screen space reflections" post-process effect. See Environment for more details.

Sets the variables to be used with the "tonemap" post-process effect. See Environment for more details.

Removes buffers and clears testcubes.

Forces a frame to be drawn when the function is called. Drawing a frame updates all Viewports that are set to update. Use with extreme caution.

Synchronizes threads.

Tries to free an object in the VisualServer.

Returns a certain information, see VisualServerRenderInfo for options.

Returns the id of the test cube. Creates one if none exists.

Returns the id of the test texture. Creates one if none exists.

Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").

Note: When running a headless or server binary, this function returns an empty string.

Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").

Note: When running a headless or server binary, this function returns an empty string.

Returns the id of a white texture. Creates one if none exists.

Creates a GI probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all gi_probe_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this GI probe to an instance using InstanceSetBase(RID, RID) using the returned RID.

Returns the bias value for the GI probe. Bias is used to avoid self occlusion. Equivalent to Bias.

Returns the axis-aligned bounding box that covers the full extent of the GI probe.

Returns the cell size set by GiProbeSetCellSize(RID, Single).

Returns the data used by the GI probe.

Returns the dynamic range set for this GI probe. Equivalent to DynamicRange.

Returns the energy multiplier for this GI probe. Equivalent to Energy.

Returns the normal bias for this GI probe. Equivalent to NormalBias.

Returns the propagation value for this GI probe. Equivalent to Propagation.

Returns the Transform set by GiProbeSetToCellXform(RID, Transform).

Returns true if the GI probe data associated with this GI probe is compressed. Equivalent to Compress.

Returns true if the GI probe is set to interior, meaning it does not account for sky light. Equivalent to Interior.

Sets the bias value to avoid self-occlusion. Equivalent to Bias.

Sets the axis-aligned bounding box that covers the extent of the GI probe.

Sets the size of individual cells within the GI probe.

Sets the compression setting for the GI probe data. Compressed data will take up less space but may look worse. Equivalent to Compress.

Sets the data to be used in the GI probe for lighting calculations. Normally this is created and called internally within the GIProbe node. You should not try to set this yourself.

Sets the dynamic range of the GI probe. Dynamic range sets the limit for how bright lights can be. A smaller range captures greater detail but limits how bright lights can be. Equivalent to DynamicRange.

Sets the energy multiplier for this GI probe. A higher energy makes the indirect light from the GI probe brighter. Equivalent to Energy.

Sets the interior value of this GI probe. A GI probe set to interior does not include the sky when calculating lighting. Equivalent to Interior.

Sets the normal bias for this GI probe. Normal bias behaves similar to the other form of bias and may help reduce self-occlusion. Equivalent to NormalBias.

Sets the propagation of light within this GI probe. Equivalent to Propagation.

Sets the to cell Transform for this GI probe.

Returns true if changes have been made to the VisualServer's data. Draw(Boolean, Double) is usually called if this happens.

Not yet implemented. Always returns false.

Returns true if the OS supports a certain feature. Features might be s3tc, etc, etc2, pvrtc and skinning_fallback.

When rendering with GLES2, returns true with skinning_fallback in case the hardware doesn't support the default GPU skinning process.

Sets up ImmediateGeometry internals to prepare for drawing. Equivalent to Begin(MeshPrimitiveType, Texture).

Clears everything that was set up between ImmediateBegin(RID, VisualServerPrimitiveType, RID) and ImmediateEnd(RID). Equivalent to Clear.

Sets the color to be used with next vertex. Equivalent to SetColor(Color).

Creates an immediate geometry and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all immediate_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this immediate geometry to an instance using InstanceSetBase(RID, RID) using the returned RID.

Ends drawing the ImmediateGeometry and displays it. Equivalent to End.

Returns the material assigned to the ImmediateGeometry.

Sets the normal to be used with next vertex. Equivalent to SetNormal(Vector3).

Sets the material to be used to draw the ImmediateGeometry.

Sets the tangent to be used with next vertex. Equivalent to SetTangent(Plane).

Sets the UV to be used with next vertex. Equivalent to SetUv(Vector2).

Sets the UV2 to be used with next vertex. Equivalent to SetUv2(Vector2).

Adds the next vertex using the information provided in advance. Equivalent to AddVertex(Vector3).

Adds the next vertex using the information provided in advance. This is a helper class that calls ImmediateVertex(RID, Vector3) under the hood. Equivalent to AddVertex(Vector3).

Initializes the visual server. This function is called internally by platform-dependent code during engine initialization. If called from a running game, it will not do anything.

Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with InstancesCullAabb(AABB, RID), InstancesCullConvex(Array, RID), and InstancesCullRay(Vector3, Vector3, RID).

Attaches a skeleton to an instance. Removes the previous skeleton from the instance.

Creates a visual instance and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all instance_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, and reflection probes need to be associated with an instance to be visible in the scenario using InstanceSetBase(RID, RID).

Creates a visual instance, adds it to the VisualServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all instance_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Not implemented in Godot 3.x.

Sets the shadow casting setting to one of VisualServerShadowCastingSetting. Equivalent to CastShadow.

Not implemented in Godot 3.x.

Sets the flag for a given VisualServerInstanceFlags. See VisualServerInstanceFlags for more details.

Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to MaterialOverride.

Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as MeshInstance or DirectionalLight. Use @GDScript.instance_from_id to obtain the actual nodes. A scenario RID must be provided, which is available in the World you want to query. This forces an update for all resources queued to update.

Warning: This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.

Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as MeshInstance or DirectionalLight. Use @GDScript.instance_from_id to obtain the actual nodes. A scenario RID must be provided, which is available in the World you want to query. This forces an update for all resources queued to update.

Warning: This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.

Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as MeshInstance or DirectionalLight. Use @GDScript.instance_from_id to obtain the actual nodes. A scenario RID must be provided, which is available in the World you want to query. This forces an update for all resources queued to update.

Warning: This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.

Sets the base of the instance. A base can be any of the 3D objects that are created in the VisualServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap capture, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario.

Sets the weight for a given blend shape associated with this instance.

Sets a custom AABB to use when culling objects from the view frustum. Equivalent to SetCustomAabb(AABB).

Function not implemented in Godot 3.x.

Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to ExtraCullMargin.

Sets the render layers that this instance will be drawn to. Equivalent to Layers.

Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.

Sets the material of a specific surface. Equivalent to SetSurfaceMaterial(Int32, Material).

Sets the world space transform of the instance. Equivalent to Transform.

Sets the lightmap to use with this instance.

Sets whether an instance is drawn or not. Equivalent to Visible.

If true, this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to DirectionalShadowBlendSplits.

Sets the shadow depth range mode for this directional light. Equivalent to DirectionalShadowDepthRange. See VisualServerLightDirectionalShadowDepthRangeMode for options.

Sets the shadow mode for this directional light. Equivalent to DirectionalShadowMode. See VisualServerLightDirectionalShadowMode for options.

Creates a lightmap capture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all lightmap_capture_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this lightmap capture to an instance using InstanceSetBase(RID, RID) using the returned RID.

Returns the size of the lightmap capture area.

Returns the energy multiplier used by the lightmap capture.

Returns the octree used by the lightmap capture.

Returns the cell subdivision amount used by this lightmap capture's octree.

Returns the cell transform for this lightmap capture's octree.

Returns true if capture is in "interior" mode.

Sets the size of the area covered by the lightmap capture. Equivalent to Bounds.

Sets the energy multiplier for this lightmap capture. Equivalent to Energy.

Sets the "interior" mode for this lightmap capture. Equivalent to Interior.

Sets the octree to be used by this lightmap capture. This function is normally used by the BakedLightmap node. Equivalent to Octree.

Sets the subdivision level of this lightmap capture's octree. Equivalent to CellSubdiv.

Sets the octree cell transform for this lightmap capture's octree. Equivalent to CellSpaceTransform.

Sets whether to use vertical or horizontal detail for this omni light. This can be used to alleviate artifacts in the shadow map. Equivalent to OmniShadowDetail.

Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to OmniShadowMode.

Sets the bake mode for this light, see VisualServerLightBakeMode for options. The bake mode affects how the light will be baked in BakedLightmaps and GIProbes.

Sets the color of the light. Equivalent to LightColor.

Sets the cull mask for this Light. Lights only affect objects in the selected layers. Equivalent to LightCullMask.

If true, light will subtract light instead of adding light. Equivalent to LightNegative.

Sets the specified light parameter. See VisualServerLightParam for options. Equivalent to SetParam(LightParam, Single).

Not implemented in Godot 3.x.

If true, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double sided shadows with InstanceGeometrySetCastShadowsSetting(RID, VisualServerShadowCastingSetting). Equivalent to ShadowReverseCullFace.

If true, light will cast shadows. Equivalent to ShadowEnabled.

Sets the color of the shadow cast by the light. Equivalent to ShadowColor.

Sets whether GI probes capture light information from this light. Deprecated method. Use LightSetBakeMode(RID, VisualServerLightBakeMode) instead. This method is only kept for compatibility reasons and calls LightSetBakeMode(RID, VisualServerLightBakeMode) internally, setting the bake mode to or depending on the given parameter.

Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.

Creates an empty material and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all material_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Returns the value of a certain material's parameter.

Returns the default value for the param if available. Otherwise returns an empty Variant.

Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.

Sets a material's line width.

Sets an object's next material.

Sets a material's parameter.

Sets a material's render priority.

Sets a shader material's shader.

Adds a surface generated from the Arrays to a mesh. See VisualServerPrimitiveType constants for types.

Removes all surfaces from a mesh.

Creates a new mesh and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all mesh_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this mesh to an instance using InstanceSetBase(RID, RID) using the returned RID.

Returns a mesh's blend shape count.

Returns a mesh's blend shape mode.

Returns a mesh's custom aabb.

Returns a mesh's number of surfaces.

Removes a mesh's surface.

Sets a mesh's blend shape count.

Sets a mesh's blend shape mode.

Sets a mesh's custom aabb.

Returns a mesh's surface's aabb.

Returns a mesh's surface's vertex buffer.

Returns a mesh's surface's amount of indices.

Returns a mesh's surface's amount of vertices.

Returns a mesh's surface's buffer arrays.

Returns a mesh's surface's arrays for blend shapes.

Returns the format of a mesh's surface.

Function is unused in Godot 3.x.

Function is unused in Godot 3.x.

Returns a mesh's surface's index buffer.

Returns a mesh's surface's material.

Returns the primitive type of a mesh's surface.

Returns the aabb of a mesh's surface's skeleton.

Sets a mesh's surface's material.

Updates a specific region of a vertex buffer for the specified surface. Warning: this function alters the vertex buffer directly with no safety mechanisms, you can easily corrupt your mesh.

Allocates space for the multimesh data. Format parameters determine how the data will be stored by OpenGL. See VisualServerMultimeshTransformFormat, VisualServerMultimeshColorFormat, and VisualServerMultimeshCustomDataFormat for usage. Equivalent to InstanceCount.

Creates a new multimesh on the VisualServer and returns an RID handle. This RID will be used in all multimesh_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this multimesh to an instance using InstanceSetBase(RID, RID) using the returned RID.

Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.

Returns the number of instances allocated for this multimesh.

Returns the RID of the mesh that will be used in drawing this multimesh.

Returns the number of visible instances for this multimesh.

Returns the color by which the specified instance will be modulated.

Returns the custom data associated with the specified instance.

Returns the Transform of the specified instance.

Returns the Transform2D of the specified instance. For use when the multimesh is set to use 2D transforms.

Sets the color by which this instance will be modulated. Equivalent to SetInstanceColor(Int32, Color).

Sets the custom data for this instance. Custom data is passed as a Color, but is interpreted as a vec4 in the shader. Equivalent to SetInstanceCustomData(Int32, Color).

Sets the Transform for this instance. Equivalent to SetInstanceTransform(Int32, Transform).

Sets the Transform2D for this instance. For use when multimesh is used in 2D. Equivalent to SetInstanceTransform2d(Int32, Transform2D).

Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.

All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc.

Transform is stored as 12 floats, Transform2D is stored as 8 floats, COLOR_8BIT / CUSTOM_DATA_8BIT is stored as 1 float (4 bytes as is) and COLOR_FLOAT / CUSTOM_DATA_FLOAT is stored as 4 floats.

Sets the mesh to be drawn by the multimesh. Equivalent to Mesh.

Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to VisibleInstanceCount.

Creates a new omni light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most light_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this omni light to an instance using InstanceSetBase(RID, RID) using the returned RID.

Creates a particle system and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all particles_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach these particles to an instance using InstanceSetBase(RID, RID) using the returned RID.

Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to CaptureAabb.

Returns true if particles are currently set to emitting.

Returns true if particles are not emitting and particles are set to inactive.

Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to InstancesCullAabb(AABB, RID), InstancesCullConvex(Array, RID), or InstancesCullRay(Vector3, Vector3, RID).

Reset the particles on the next update. Equivalent to Restart.

Sets the number of particles to be drawn and allocates the memory for them. Equivalent to Amount.

Sets a custom axis-aligned bounding box for the particle system. Equivalent to VisibilityAabb.

Sets the draw order of the particles to one of the named enums from VisualServerParticlesDrawOrder. See VisualServerParticlesDrawOrder for options. Equivalent to DrawOrder.

Sets the number of draw passes to use. Equivalent to DrawPasses.

Sets the mesh to be used for the specified draw pass. Equivalent to DrawPass1, DrawPass2, DrawPass3, and DrawPass4.

Sets the Transform that will be used by the particles when they first emit.

If true, particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to Emitting.

Sets the explosiveness ratio. Equivalent to Explosiveness.

Sets the frame rate that the particle system rendering will be fixed to. Equivalent to FixedFps.

If true, uses fractional delta which smooths the movement of the particles. Equivalent to FractDelta.

Sets the lifetime of each particle in the system. Equivalent to Lifetime.

If true, particles will emit once and then stop. Equivalent to OneShot.

Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to Preprocess.

Sets the material for processing the particles. Note: this is not the material used to draw the materials. Equivalent to ProcessMaterial.

Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to Randomness.

Sets the speed scale of the particle system. Equivalent to SpeedScale.

If true, particles use local coordinates. If false they use global coordinates. Equivalent to LocalCoords.

Creates a reflection probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all reflection_probe_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this reflection probe to an instance using InstanceSetBase(RID, RID) using the returned RID.

If true, reflections will ignore sky contribution. Equivalent to InteriorEnable.

Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to CullMask.

If true, uses box projection. This can make reflections look more correct in certain situations. Equivalent to BoxProjection.

If true, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to EnableShadows.

Sets the size of the area that the reflection probe will capture. Equivalent to Extents.

Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to Intensity.

Sets the ambient light color for this reflection probe when set to interior mode. Equivalent to InteriorAmbientColor.

Sets the energy multiplier for this reflection probes ambient light contribution when set to interior mode. Equivalent to InteriorAmbientEnergy.

Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to interior mode. Useful so that ambient light matches the color of the room. Equivalent to InteriorAmbientContrib.

Sets the max distance away from the probe an object can be before it is culled. Equivalent to MaxDistance.

Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to OriginOffset.

Sets how often the reflection probe updates. Can either be once or every frame. See VisualServerReflectionProbeUpdateMode for options.

Schedules a callback to the corresponding named method on where after a frame has been drawn.

The callback method must use only 1 argument which will be called with userdata.

Creates a scenario and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all scenario_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

The scenario is the 3D world that all the visual instances exist in.

Sets the VisualServerScenarioDebugMode for this scenario. See VisualServerScenarioDebugMode for options.

Sets the environment that will be used with this scenario.

Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment.

Sets the size of the reflection atlas shared by all reflection probes in this scenario.

Sets a boot image. The color defines the background color. If scale is true, the image will be scaled to fit the screen size. If use_filter is true, the image will be scaled with linear interpolation. If use_filter is false, the image will be scaled with nearest-neighbor interpolation.

If true, the engine will generate wireframes for use with the wireframe debug mode.

Sets the default clear color which is used when a specific clear color has not been selected.

Sets the scale to apply to the passage of time for the shaders' TIME builtin.

The default value is 1.0, which means TIME will count the real time as it goes by, without narrowing or stretching it.

Creates an empty shader and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all shader_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Returns a shader's code.

Returns a default texture from a shader searched by name.

Returns the parameters of a shader.

Sets a shader's code.

Sets a shader's default texture. Overwrites the texture given by name.

Allocates the GPU buffers for this skeleton.

Returns the Transform set for a specific bone of this skeleton.

Returns the Transform2D set for a specific bone of this skeleton.

Sets the Transform for a specific bone of this skeleton.

Sets the Transform2D for a specific bone of this skeleton.

Creates a skeleton and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all skeleton_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Returns the number of bones allocated for this skeleton.

Creates an empty sky and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all sky_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Sets a sky's texture.

Creates a spot light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most light_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

To place in a scene, attach this spot light to an instance using InstanceSetBase(RID, RID) using the returned RID.

Not implemented in Godot 3.x.

Allocates the GPU memory for the texture.

Binds the texture to a texture slot.

Creates an empty texture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all texture_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Creates a texture, allocates the space for an image, and fills in the image.

Returns a list of all the textures and their information.

Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the RID of the image at one of the cubes sides.

Returns the depth of the texture.

Returns the flags of a texture.

Returns the format of the texture's image.

Returns the texture's height.

Returns the texture's path.

Returns the opengl id of the texture's image.

Returns the type of the texture, can be any of the VisualServerTextureType.

Returns the texture's width.

Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.

Sets a part of the data for a texture. Warning: this function calls the underlying graphics API directly and may corrupt your texture if used improperly.

Sets the texture's flags. See VisualServerTextureFlags for options.

Sets the texture's path.

If true, sets internal processes to shrink all image data to half the size.

Resizes the texture to the specified dimensions.

If true, the image will be stored in the texture's images array if overwritten.

Sets a viewport's camera.

Sets a viewport's canvas.

Copies viewport to a region of the screen specified by rect. If RenderDirectToScreen is true, then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.

For example, you can set the root viewport to not render at all with the following code:

func _ready():
    get_viewport().set_attach_to_screen_rect(Rect2())
    $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))

Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, ViewportSetRenderDirectToScreen(RID, Boolean).

Creates an empty viewport and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all viewport_* VisualServer functions.

Once finished with your RID, you will want to free the RID using the VisualServer's FreeRid(RID) static method.

Detaches the viewport from the screen.

Returns a viewport's render information. For options, see the VisualServerViewportRenderInfo constants.

Returns the viewport's last rendered frame.

Detaches a viewport from a canvas and vice versa.

If true, sets the viewport active, else sets it inactive.

Sets the stacking order for a viewport's canvas.

layer is the actual canvas layer, while sublayer specifies the stacking order of the canvas among those in the same layer.

Sets the transformation of a viewport's canvas.

Sets the clear mode of a viewport. See VisualServerViewportClearMode for options.

Sets the debug draw mode of a viewport. See VisualServerViewportDebugDraw for options.

If true, a viewport's 3D rendering is disabled.

If true, rendering of a viewport's environment is disabled.

Sets the viewport's global transformation matrix.

If true, the viewport renders to hdr.

If true, the viewport's canvas is not rendered.

Currently unimplemented in Godot 3.x.

Sets the anti-aliasing mode. See VisualServerViewportMSAA for options.

Sets the viewport's parent to another viewport.

If true, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the SCREEN_TEXTURE. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size.

Sets a viewport's scenario.

The scenario contains information about the VisualServerScenarioDebugMode, environment information, reflection atlas etc.

Sets the shadow atlas quadrant's subdivision.

Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2.

Sets the viewport's width and height.

If true, the viewport renders its background as transparent.

Sets when the viewport should be updated. See VisualServerViewportUpdateMode constants for options.

Sets the viewport's 2D/3D mode. See VisualServerViewportUsage constants for options.

If true, the viewport uses augmented or virtual reality technologies. See ARVRInterface.

If true, uses a fast post-processing filter to make banding significantly less visible. In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.

Note: Only available on the GLES3 backend. Hdr must also be true for debanding to be effective.

Enables fast approximate antialiasing for this viewport. 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.

If true, the viewport's rendering is flipped vertically.