Skip to main content

Render Graph

Asset ID:render_graph

A render graph used by a camera

Asset schema properties

uuid

uuid

Unique identifier for the asset

name

string

Name of the asset

blendStateDescriptions

array[object]

All blend states

Pipeline color blend attachment state

alphaBlendOp

integer

Alpha blend operator

blendEnable

boolean

Enable blending

colorBlendOp

integer

Color blend operator

colorWriteMask

integer

Color write mask

dstAlphaBlendFactor

integer

Destination alpha blend factor

dstColorBlendFactor

integer

Destination color blend factor

srcAlphaBlendFactor

integer

Source alpha blend factor

srcColorBlendFactor

integer

Source color blend factor

conditions

array[string]

Conditions referenced by conditionIndex

defaultRenderTargetIndex

uint32

Default:0

The index of the render target to blit into the canvas

graphOrder

array[array]

The order in which to interpret the nodes

inputDescriptor

array[object]

Input descriptor used to parse input data

Parameter description

name

string

Parameter name

categories

array[string]

Categories

default

Parameter default value

nativeType

Parameter native type

type

Parameter type

nodeDataDescriptions

array[object]

Descriptions of all nodes

The description of a render graph node

name

string

Node name

conditionIndex

int16

Default:-1

Index into the conditions array; -1 if unconditional

type

int8

0viewport1draw_batch2draw_batch_with_materials3dispatch_compute4blit_image5DEPRECATED__blit_pixels_at_pointer_positions6copy_image7resolve_image8draw_fullscreen9generate_mip_chain10copy_to_cubemap_face11DEPRECATED__copy_to_light_cubemap12DEPRECATED__copy_to_reflection_cubemap13clear_images14DEPRECATED__timestamp15fill_buffer16draw_debug_lines17dispatch_decals_compute18set_depth_bias19dispatch_ray_tracing

Node type

occlusionInputDepthRenderTargetIndex

uint32

The index of the render target used for occlusion

renderPassDescriptions

array[object]

Descriptions of all render passes

Description of a render pass

name

string

Default:"<unnamed_render_pass>"

Render pass name

attachmentClearColors

array[array]

The attachments clear colors

attachmentDescriptions

array[object]

The attachment descriptions

Vulkan Attachment description

finalLayout

integer

Final layout

flags

integer

Attachment description flags

format

integer

Format

initialLayout

integer

Initial layout

loadOp

integer

Load op

samples

integer

Sample count

stencilLoadOp

integer

Stencil load op

stencilStoreOp

integer

Stencil store op

storeOp

integer

Store op

colorAttachmentIndices

array[uint32]

The indices of the render targets used as color attachments for this render pass

colorAttachmentReferences

array[object]

The attachment references of the render targets used as color attachments for this render pass

Vulkan Attachment reference

attachment

uint32

Attachment

layout

integer

Layout

conditionIndex

int16

Default:-1

Index into the conditions array; -1 if unconditional

depthAttachmentIndex

uint32

The index of the render target used as depth attachment for this render pass

depthAttachmentReference

object

{

attachment,

layout,

}

The attachment reference of the render target used as depth attachment for this render pass

nodeIndices

array[uint32]

The indices of the nodes composing this render pass

resolveAttachmentIndices

array[uint32]

The indices of the render targets used as resolve attachments for this render pass

resolveAttachmentReferences

array[object]

The attachment references of the render targets used as resolve attachments for this render pass

Vulkan Attachment reference

attachment

uint32

Attachment

layout

integer

Layout

sampleCount

uint8

Default:1

Multisampling

renderTargetDescriptions

array[object]

Descriptions of all render targets

Description of a render target

name

string

Default:"<unnamed_rt>"

Render target name

aspect

integer

Default:"VK_IMAGE_ASPECT_COLOR_BIT"

The aspect of the image to use, in the graph

denoiserTarget

int8

-1none0color1albedo2normals3output

Default:-1(none)

The denoiser target this render target maps to

extent

array[float]

Default:[0,0,0]

The extent of the render target, leave at 0 to use the canvas extent

flags

integer

Default:0

Flags to use on image creation

format

integer

Default:"VK_FORMAT_UNDEFINED"

Format of the render target

memoryType

int8

0invalid1local2exportable3imported

Default:"vk::memory_type::local"

Memory type

memoryUsage

int8

0gpu_only1cpu_to_gpu2gpu_to_cpu3gpu_to_cpu_cached

Default:"vk::memory_usage_gpu_only"

How the image is accessed

mipLevels

uint32

Default:1

Number of mip maps

pickingTarget

int8

-1none0ws_position_id1ws_normal

Default:-1(none)

The picking target this render target maps to

sampleCount

integer

Default:"VK_SAMPLE_COUNT_1_BIT"

Number of samples per pixel

samplerType

uint32

Default:0

THe sampler to use when accessing this render target

tiling

integer

Default:"VK_IMAGE_TILING_OPTIMAL"

Tiling of the image

usage

integer

Default:0

How this render target is going to be used

stencilOpStateDescriptions

array[object]

All stencil states

Stencil operators state

compareMask

uint32

Compare mask

compareOp

integer

Compare operator

depthFailOp

integer

Depth fail operator

failOp

integer

Fail operator

passOp

integer

Pass operator

reference

uint32

Reference

writeMask

uint32

Write mask