ProtectedconstructorOptionalisInternalConstructor: booleanActivates or deactivates the component.
The returned active state also accounts for the active state of the parent SceneObject.
Returns the aspect ratio used by the camera.
Settings that control (post-processing) effects for this view. The settings determine how the renderer process this view, which effects will be enabled, and what properties will those effects use.
Determines flags used for controlling the camera behavior.
Various flags set on the component that affect it's behavior.
Gets the unique camera ID. This is used internally to reference the camera from the renderer data.
Determines whether the component itself is active, without accounting for the active state of the parent scene object.
Returns true if a custom projection matrix is used.
Returns true if a custom view matrix is used.
Determines if the object has been destroyed.
Checks if the camera is the main camera.
Determines if the component is currently active, enabled and running.
Determines the cases that will trigger the onTransformChanged event.
Returns the PhysicsScene this node is being simulated on.
Determines a priority that determines in which orders the cameras are rendered. This only applies to cameras rendering to the same render target. Higher value means the camera will be rendered sooner.
The signed execution priority of the component.
Determines order of execution of this component in relation to other components, higher priorities will execute earlier.
The priority value determines the order of initialize, enable and update calls.
Valid priorities are in the range [-100...100], other priorities are reserved for internal use.
The priority should not be modified after onCreate has been called.
The default priority for user implement components is -10. BuiltinComponent have a default priority of 0. However, instances that have dependencies or are a dependency to another component might have non zero default priorities. For example, the Camera component has a default priority of 50 as other components may depend on the camera being initialized early. The Rigidbody component has a default priority of 22 and Joint components have a priority of 20 as the joint depends on fully initialized rigid bodies.
Gets the camera project mode.
Returns the SceneInstance this node is attached to.
Returns the SceneObject this component is attached to.
Assigns settings that define the camera.
Returns a universally unique identifier that persists scene save/load.
Returns the viewport used by the camera.
Destroys the component, removing it from its scene object and stopping component updates.
Optionalimmediate: boolean
If true the component will be fully destroyed immediately. This means that objects that are still referencing this component might fail. Normally destruction is delayed until the end of the frame to give other objects a chance to stop using it.
Checks if the component has a specific ComponentFlag bit flag set.
The flag to check.
Calls a parameterless method with the specified name, on the component.
Name of the method to call.
true if the method was invoked.
Makes the camera as the main one.
Converts a point in normalized device coordinates to view space.
3D point relative to the camera's coordinate system.
Converts a point in normalized device coordinates to world space.
3D point in world space.
Notifies the renderer that the effect settings changed.
Notifies a on-demand camera that it should re-draw its contents on the next frame. Ignored for a camera that isn't on-demand.
ProtectedonProtectedonProtectedonVirtual
Called every time a component is placed into the Stopped state.
This method may be called during component destruction, if the component wasn't already in ScenePlayState.Stopped state during destruction. When called during destruction, it is called before onDestroy.
ProtectedonVirtual
Called every time a component leaves the ScenePlayState.Stopped state.
This method might be called during component creation, if the requirements for leaving the stopped state are met. One such case would be a component class that has the runInEditor attribute. When called during creation it is called after onInitialize.
Called at fixed time intervals (e.g. 60 times per frame). Only called if the component is in ScenePlayState.Playing state.
ProtectedonVirtual
Called once when the component first leaves the ScenePlayState.Stopped state.
This method might be called during component creation, if the requirements for leaving the stopped state are met. One such case would be a component class that has the runInEditor attribute. When called during creation it is called after onCreate.
Virtual
Called once per frame, after all other components received their onUpdate invocation. Only called if the component is in ScenePlayState.Playing state.
This method should only be implemented if your component needs logic that implements on other component or SceneObject changes performend in onUpdate. An example could be a camera controller logic that updates in response to changes to the object that is being tracked.
ProtectedonVirtual
Called when the script domain has been refreshed or when the component is initialized. During initialization it is called after onInitialize but before onEnable.
ProtectedonVirtual
Called when the component's parent SceneObject has changed.
The transform flags.
This method is only called if TransformChangedFlag.Transform is set on the Component#notifyFlags. The method will also not be called if the component is currently in the ScenePlayState.Stopped state.
To get the event for editor components that are active outside the simulation, attach the runInEditor attribute to your component class.
Virtual
Called once per frame. Only called if the component is in ScenePlayState.Playing state.
Projects a point in view space to normalized device coordinates. Similar to ViewToNDCPoint() but preserves the depth component.
3D point in normalized device coordinates ([-1, 1] range), relative to the camera's viewport. Z value range depends on active render API.
Triggers the rendering operation for this particular camera. The results will be written to the render target provided in
target.
Triggers the rendering operation for this particular camera. The results will be written to RenderTarget in camera viewport settings.
Converts a point in screen space to a point in view space.
3D point relative to the camera's coordinate system.
Converts a point in screen space to a point in world space.
3D point in world space.
Converts a point in screen space (pixels corresponding to render target attached to the camera) to a point in world space.
3D point in world space.
Sets whether the camera should use the custom projection matrix. When this is enabled camera will no longer calculate its projection matrix based on field of view, aspect and other parameters and caller will be resonsible to keep the projection matrix up to date.
Sets or unsets the specified ComponentFlag bit flag on the instance.
The flag to set.
True to set the flag.
Registers the coroutine for the specified component using the provided args as arguments.
true if the coroutine was registered.
The coroutine will be called for the first time when the coroutine subsystem runs for update events.
There is no guarantee with regards to the order of how coroutines are invoked.
Coroutines are a great way for time-deferred or delayed system. To implement a coroutine simply add a
generator method to your component and register it as coroutine:
public *myCoroutine(text:string)
{
const endTime:number = Time.realElapsed + 3;
while(Time.realElapsed < endTime)
{
yield true;
}
Debug.log("This code will be invoked after 3 seconds with the text=" + text);
}
To register the function simply call
this.startCoroutine(this.myCoroutine, "Hello World!");
The function will be invoked once the coroutine runs. The coroutine function can yield the program
control flow by using the keyword yield. The coroutine will then stop execution at that point,
and pick up the execution in the next update event, right after the yield keyword that caused
the coroutine to pause.
With helper functions such as waitForSeconds or waitForAsyncOp it is easy to create coroutines that pause for a set time interval.
Registers the coroutine for the specified component using the provided args as arguments.
true if the coroutine was registered.
The coroutine will be called for the first time when the coroutine subsystem runs for fixedUpdate events.
There is no guarantee with regards to the order of how coroutines are invoked.
Coroutines are a great way for time-deferred or delayed system. To implement a coroutine simply add a
generator method to your component and register it as coroutine:
public *myCoroutine(text:string)
{
const endTime:number = Time.realElapsed + 3;
while(Time.realElapsed < endTime)
{
yield true;
}
Debug.log("This code will be invoked after 3 seconds!");
}
To register the function simply call
this.startCoroutine(this.myCoroutine, "Hello World!");
The function will be invoked once the coroutine runs. The coroutine function can yield the program
control flow by using the keyword yield. The coroutine will then stop execution at that point,
and pick up the execution in the next fixedUpdate event, right after the yield keyword that caused
the coroutine to pause.
With helper functions such as waitForSeconds or waitForAsyncOp it is easy to create coroutines that pause for a set time interval.
Stops the coroutine for the specified component.
The coroutine to stop.
true if the coroutine was registered.
Returns a string representation of an object.
Un-projects a point in normalized device space to view space.
3D point relative to the camera's coordinate system.
StaticgetLocates a rsx object by its sceneRuntimeID and UUID.
The runtime ID of the SceneInstance of the object.
The UUID of the object to retrieve.
The object or null if no object with given sceneRuntimeID and uuid has been registered
The Camera component is the core element in RSX Engine responsible for defining how the 3D world is viewed and projected onto a 2D screen or render target. It controls the position, orientation, field of view, projection type (perspective or orthographic), culling layers, post-processing effects, and viewport settings. The camera automatically computes view and projection matrices unless custom matrices are explicitly enabled.
Attaching a Camera component to a
SceneObjectturns that object into a virtual camera. Multiple cameras can exist in a scene, with rendering order determined by their priority value (higher priority renders first). Once a Camera has a valid render target, it is capable of rendering the scene, either automatically or manually, depending on the flags.Key Features - Perspective and orthographic projection modes - Full control over viewport, aspect ratio, and render target
LayerMask- Built-in post-processing via EffectSettings - Comprehensive coordinate conversion utilities (screen ↔ view ↔ world ↔ NDC) - Custom view/projection matrix support - Priority-based multi-camera compositingrender()Common Use Cases - Main gameplay camera - UI/overlays (orthographic) - Security cameras / picture-in-picture - Render
textures for mirrors, portals, or mini-maps - Cinematic sequences with custom projection
Example