Example Node: Cpu To Disk

Saves specified CPU buffer to disk

Installation

To use this Node, you must enable omni.graph.examples.cpp in the Extension Manager.

Inputs

Name

Type

Description

Default

gpuFoundations (gpu)

uint64

Pointer to shared context containing gpu foundations

renderProduct (rp)

uint64

Pointer to render product for this view

startFrame (startFrame)

uint64

Frame to begin saving to disk

0

frameCount (frameCount)

int64

Number of frames to capture (-1 means never stop)

-1

activeReset (active)

bool

Alternative to frameCount/startFrame, does a single frame then autoResets to false

False

saveLocation (saveLocation)

string

Folder to save AOVs as AOV_FrameNumber.{exr,png}

fileType (fileType)

string

bmp,png,exr

png

fileName (fileName)

string

Optional, if specified the output filename will be fileName_{aovGpu}.{fileType}

maxInflightWrites (maxInflightWrites)

int

Maximum number of in-flight file write operations before blocking on file i/o

2

aovGpu (aovGpu)

string

Name of AOV representing GPU resource, used for querying format + properties

aovCpu (aovCpu)

string

Name of AOV representing CPU buffer of GPU resource

fileNumber (fileNumber)

int

Number that will be appended to the exported filename. If -1 then the render product’s frame number will be used.

-1

autoFileNumber (autoFileNumber)

int

If non zero, this number will be the starting number for export. Each invocation of this node increases the number by 1.

-1

saveFlags (saveFlags)

uint64

Flags that will be passed to carb::imaging::IImaging for file saving.

0

Outputs

Name

Type

Description

Default

gpuFoundations (gpu)

uint64

Pointer to shared context containing gpu foundations

renderProduct (rp)

uint64

Pointer to render product for this view