Package com.mi.rs
Interface public interface IRenderCommand extends ICommand
Implementors RenderCommand

Defines the interface for commands that return an image. Render commands are associated with a specific ImageRenderTarget which will display or hold the renderd image.

Each render command will render a single frame. To implement a client side render loop, simply add new RenderCommands to the service, either periodically or when something has changed, like the camera transform. Note that render commands are very expensive so it is vital to use the process commands callbacks mechanism to make sure that no redundant render commands are added to the service. This is of course true for all commands but especially important for render commands.

Any number of render commands can be added at a single time, so if multiple ImageRenderTarget instances needs to be updated it is perfectly ok to add multiple render commands without waiting for previous commands to complete. Note however that render commands, like all other commands, will be serialized by the service.

See also

com.mi.rs.ImageRenderTarget


Public Properties
  Property Defined By
  Inherited isCancelled : Boolean
[read-only] This property is set to true by the implementing class if the command has been cancelled, in which case it will simply be skipped by the service.
ICommand
  Inherited name : String
[read-only] The name of the RealityServer command to call.
ICommand
  Inherited params : Object
[read-only] An associative array containing the command arguments as name/value pairs.
ICommand
    renderTarget : ImageRenderTarget
[read-only] Returns the ImageRenderTarget that will display the rendered image.
IRenderCommand
Property Detail
renderTarget property
renderTarget:ImageRenderTarget  [read-only]

Returns the ImageRenderTarget that will display the rendered image.


Implementation
    public function get renderTarget():ImageRenderTarget