Render settings

Generated from the schema registry by ernie schema --markdown.

RenderSettingsBase

What settings and products share: the camera, image and Ernie's settings.

Abstract base

Attribute	Type	Description	Fallback	Values	Source
camera	rel	The camera it renders.	""		UsdRender
resolution	double2	Pixels across and down.	[2048.0,1080.0]	≥ 1	UsdRender
pixelAspectRatio	double	A pixel's width over its height.	1.0	> 0	UsdRender
aspectRatioConformPolicy	token	How the camera's aperture meets the image's aspect.	"expandAperture"	expandAperture, cropAperture, adjustApertureWidth, adjustApertureHeight, adjustPixelAspectRatio	UsdRender
dataWindowNDC	double4	The window of the image rendered, in normalized device coordinates.	[0.0,0.0,1.0,1.0]		UsdRender
disableMotionBlur	bool	Renders the shutter's open instant.	false		UsdRender
disableDepthOfField	bool	Renders as through a pinhole.	false		UsdRender
ernie:fidelity	token	The tier: minimal for learning at scale, realtime, or predictive for reference images.	"realtime"	minimal, realtime, predictive	Ernie
ernie:samples	int	Samples per pixel per frame; 0 the tier's.	0	≥ 0	Ernie
ernie:bounces	int	Path bounces; -1 the tier's.	-1	≥ -1	Ernie
ernie:accumulation	int	Frames of temporal history; 0 none, -1 the tier's.	-1	≥ -1	Ernie
ernie:denoiser	token	The denoiser; auto the tier's (none in minimal and predictive, svgf in realtime).	"auto"	auto, none, svgf, oidn, optix, dlss, fidelityfx	Ernie
ernie:seed	int	The seed every random decision of its frames derives from.	0		Ernie
ernie:lod:error	double	Pixels of geometric error LOD allows.	1.0	> 0	Ernie
ernie:spectral:mode	token	spectral: bands over the range; rgb: three bands of linear sRGB, faster.	"spectral"	spectral, rgb	Ernie
ernie:spectral:bands	int	Bands sampled across the camera's sensor range.	16	≥ 1	Ernie

RenderSettings

A render's settings and the products it makes.

Prim type · Inherits RenderSettingsBase

Attribute	Type	Description	Fallback	Values	Source
products	rel[]	The products it renders.	[]		UsdRender
includedPurposes	token[]	The purposes of the prims rendered.	["default","render"]		UsdRender
materialBindingPurposes	token[]	The binding purposes tried, in order.	["full",""]		UsdRender
renderingColorSpace	token	The colour space rendering happens in; unset, linear Rec.709.	""		UsdRender

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/RenderSettings": {
      "typeName": "RenderSettings",
      "includedPurposes": ["default", "render"],
      "materialBindingPurposes": ["full", ""]
    }
  }
}

RenderProduct

One output, an image or a sensor's data, overriding its settings' where it authors them.

Prim type · Inherits RenderSettingsBase

Attribute	Type	Description	Fallback	Values	Source
productType	token	The kind of output.	"raster"		UsdRender
productName	token	The output's name, as a file path.	""		UsdRender
orderedVars	rel[]	The vars it holds, in order.	[]		UsdRender

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/RenderProduct": {
      "typeName": "RenderProduct",
      "productType": "raster"
    }
  }
}

RenderVar

One channel set of a product: colour, depth, normals, ids or an Ernie output.

Prim type

Attribute	Type	Description	Fallback	Values	Source
dataType	token	Each pixel's value type, as the output is written: an integer type holds a sensor's digital numbers of its bit depth. uint16 is Ernie's, for depths of 9 to 16 bits, which USD's types have no type for.	"color3f"	color3f, color4f, float, float2, float3, float4, half, half3, half4, normal3f, point3f, vector3f, uchar, uint16, uint, int, int64	UsdRender
sourceName	token	What it holds: an Ernie output (LdrColor, depth, normal...), a primvar or an LPE.	""		UsdRender
sourceType	token	How the source name is read.	"raw"	raw, primvar, lpe, intrinsic	UsdRender

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/RenderVar": {
      "typeName": "RenderVar",
      "dataType": "color3f",
      "sourceType": "raw"
    }
  }
}

RenderPass

A render of a pipeline, with the prims and cameras it sees as collections.

Prim type · Built in: CollectionAPI · Built in: CollectionAPI

Attribute	Type	Description	Fallback	Values	Source
passType	token	The kind of pass.	""		UsdRender
command	token[]	The command a pipeline runs it with.	[]		UsdRender
fileName	asset	The file it renders from.	""		UsdRender
renderSource	rel[]	The render settings it renders.	[]		UsdRender
inputPasses	rel[]	Passes it depends on.	[]		UsdRender

Fallbacks it changes: collection:renderVisibility:includeRoot true; collection:cameraVisibility:includeRoot true.

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/RenderPass": {
      "typeName": "RenderPass",
      "command": []
    }
  }
}