get_canvas_base64
Gets a canvas previously stored in a render context and returns it as a base64 encoded string.
arguments
- "canvas_name" : String
The name of the canvas.
- "datauri" : Boolean (default: false)
If true, use datauri format for the resulting image. Otherwise just the direct base64 encoded image is returned.
- "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
StringThe encoded image.