Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

screen

This node describes how the view from a camera node will be rasterized into an output layer node. It can be connected to the screens attribute of a camera node.

NameTypeDefault
outputlayers<connection>

This connection accepts output layer nodes which will receive a rendered image of the scene as seen by the camera.

NameTypeDefault
resolutioninteger[2]

Horizontal and vertical resolution of the rendered image, in pixels.

NameTypeDefault
oversamplinginteger

The total number of samples (i.e. camera rays) to be computed for each pixel in the image.

NameTypeDefault
crop2 × float[2]

The region of the image to be rendered. It’s defined by a list of exactly 2 pairs of floating-point number. Each pair represents a point in ɴᴅᴄ space:

  • Top-left corner of the crop region
  • Bottom-right corner of the crop region
NameTypeDefault
prioritywindow2 × int[2]

For progressive renders, this is the region of the image to be rendered first. It is two pairs of integers. Each represents pixel coordinates:

  • Top-left corner of the high priority region
  • Bottom-right corner of the high priority region
NameTypeDefault
screenwindow2 × double[2]

Specifies the screen space region to be rendered. Each pair represents a 2D point in screen space:

  • Bottom-left corner of the region
  • Top-right corner of the region

Note that the default screen window is set implicitly by the frame aspect ratio: screenwindow = [-f, -1], [f, 1] for f = xres/yres

NameTypeDefault
overscan2 × int[2]

Specifies how many extra pixels to render around the image. The four values represent the amount of overscan on the left, top, right and bottom of the image.

NameTypeDefault
pixelaspectratiofloat

Ratio of the physical width to the height of a single pixel. A value of 1.0 corresponds to square pixels.

NameTypeDefault
staticsamplingpatternint0

This controls whether or not the sampling pattern used to produce the image change for every frame. A nonzero value will cause the same pattern to be used for all frames. A value of zero will cause the pattern to change with the frame attribute of the global node.

NameTypeDefault
importancesamplefilterint0

This enables a rendering mode where the pixel filter is importance sampled. Quality will be reduced and the same filter will be used for all output layers of the screen. Filters with negative lobes (eg. sinc) are unsupported.