RealityServer® Web Services 4.4

create_canvas

Creates a canvas and stores it in a render context. Note that the created canvas will not by initialized. Use the 'clear_canvas' command to initialize.

arguments

• "canvas_name" : String

  The name to store the canvas as.

• "canvas_pixel_type" : String (default: "Rgba")

  The pixel type of the canvas.

  Possible Values:

  • Rgb
  • Rgba
  • Rgb_fp
  • Color
  • Rgbe
  • Rgbea
  • Rgba_16
  • Rgb_16
  • Sint8
  • Sint32
  • Float32
  • Float32<2>
  • Float32<3>
  • Float32<4>
• "canvas_resolution_x" : Uint32

  Horizontal resolution of the canvas.

• "canvas_resolution_y" : Uint32

  Vertical resolution of the canvas.

• "overwrite" : Boolean (default: false)

  If true then overwrite any existing canvas stored under this name.

• "render_context_name" : String

  The name of the render context to store the canvas in.

• "scene_name" : String

  The name of the scene that contains the render context to store the canvas in.

return value

groups

• render
• canvas