GFX.DrawablePass¶
| Name | Mandatory | Description | Default | Type |
|---|---|---|---|---|
⬅️ Input |
The input of this shard is ignored. | None |
||
Output ➡️ |
The render pass object for use in a render pipeline. | GFX.PipelineStep |
||
Name |
No | A name for this pass, to aid in debugging | none |
NoneString |
Queue |
No | The drawables queue to get drawables from. | none |
Var(GFX.DrawQueue) |
Features |
No | Features to attach to this drawable | none |
None[GFX.Feature]Var([GFX.Feature]) |
Outputs |
No | The outputs to render into | none |
None[{Any}]Var([{Any}]) |
OutputScale |
No | The scale that the output should be rendered as | {main: none} |
NoneAny |
Sort |
No | The sorting mode to use to sort the drawables. The default sorting behavior is to sort by optimal batching. | none |
NoneSortModeVar(SortMode) |
IgnoreDrawableFeatures |
No | Ignore any features on drawables and only use the features specified in this pass. | none |
NoneBool |
This shard creates a render pass object, meant for rendering drawable objects, using the drawables from the drawables queue (specified in the Queue parameter) and the sequence of features objects (specified in the Features parameter).
Details¶
The render pass object created by this shard can be placed in a sequence with other render pass objects (created by GFX.EffectPass and GFX.CopyPass). This sequence of render pass objects can then be used in conjuction with a view object (created by GFX.View) and passed to GFX.Render to produce a scene.