RealityServer® Web Services 4.4

get_canvas

Gets a canvas previously stored in a render context.

arguments

• "canvas_name" : String

  The name of the canvas.

• "format" : String (default: "jpg")

  The image format to return.

  Possible Values:

  • jpg
  • png
  • tif
  • exr
  • hdr
  • ct
• "pixel_type" : String (default: "Rgba")

  The pixel type of the returned image.

  Possible Values:

  • Rgb
  • Rgba
  • Rgb_fp
  • Color
  • Rgbe
  • Rgbea
  • Rgba_16
  • Rgb_16
  • Sint8
  • Sint32
  • Float32
  • Float32<2>
  • Float32<3>
  • Float32<4>
• "quality" : String (default: "90")

  The quality of the returned image.

• "render_context_name" : String

  The name of the render context in which the canvas is stored.

• "scene_name" : String

  The name of the scene to get the render context from.

return value

An image of the specified format, pixel type and quality.

groups

• render
• scene
• canvas