get_canvas
Gets a canvas previously stored in a render context.
Web Services Notes:
- This command is capable of returning a Canvas which cannot be serialized by Web Services. This command should only be used in that mode as a utility command by other commands and cannot be called directly from Web Services.
References:
arguments
- "canvas_name" : String
The name of the canvas.
- "encode" : Boolean (default: true)
If true the canvas is encoded based on the image format settings given and returned as a Binary. If false the canvas will be returned as a Canvas instead.
- "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
BinaryIf the encode parameter is true an image of the specified format, pixel type and quality as a Binary. Otherwise the actual Canvas is returned.