readGenerated
Category: Creation protocol · Session
Reads an output or a node’s port.
Description
Section titled “Description”Reads an output or a node’s port.
Example request
Section titled “Example request”{"id": 1, "op": "read"}Properties
Section titled “Properties”| Name | Type | Required | Description |
|---|---|---|---|
output |
string |
no | a scene output; the first when neither it nor node is given |
node |
string |
no | a node, with port |
port |
string |
no | the node’s port; result when not given |
format |
"png" | "rgba32f" | "ppm" | "summary" | "words" | "field" |
no | a picture (a Grid of pixels) as png (when not given), rgba32f or ppm; any Field as its summary (when not given and not a picture), its words or the Host’s field file |
from |
integer |
no | the first element to answer as numbers, counted along the Field, x fastest, then y, then z; 0 when not given |
count |
integer |
no | how many elements from from to answer as numbers, at most 4096; 1 when not given |
Answer
Section titled “Answer”a picture: width, height, format, data (base64). Any other Field: shape, extent, count, schema, fields (each number’s name in an element of several, hp, pos.x), and its summary (each number’s min, max, sum, mean, how many were not zero, and how many were not finite), or values from from (a number, or a list for an element of several), or format and data (base64)