CommandEncoder class abstract interface

A pass somebody opened, and must therefore close.

Held by whatever created it — a RenderNode, or the renderer's own passes. A PassContributor gets the PassEncoder half instead and cannot submit.

Implemented types
Implementers
Available extensions

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

bindIndexBuffer(GeometryBuffer buffer, IndexType type, int indexCount) → void
inherited
bindIndexData(ByteData bytes, IndexType type, int indexCount) → void
Binds indices built this frame. See bindVertexData.
inherited
bindPipeline(PipelineHandle pipeline) → void
Binds the pair of stages the following draws run.
inherited
bindTexture(ShaderHandle shader, String slot, TextureHandle texture, {SamplerOptions? sampler}) → void
Binds texture to the sampler called slot in shader.
inherited
bindUniformBlock(ShaderHandle shader, String blockName, Map<String, Float32List> members) → bool
Fills the uniform block blockName of shader from members and binds it. False when the shader has no such block.
inherited
bindVertexBuffer(GeometryBuffer buffer, int vertexCount, {int slot = 0}) → void
Binds geometry the device already holds — a mesh, or the one triangle every full-screen pass draws.
inherited
bindVertexData(ByteData bytes, int vertexCount, {int slot = 0}) → void
Binds vertices built this frame.
inherited
clearBindings() → void
Forgets every binding, leaving rasteriser state alone.
inherited
draw({int instanceCount = 1}) → void
Draws what is bound. Always indexed — there is no non-indexed path in this engine, which is why the debug overlay keeps an identity index sequence.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setBlend(BlendState? state, {int attachment = 0}) → void
Blending for one colour attachment; null switches it off.
inherited
setBlendColor(Vector4 color) → void
The constant the four constant-reading BlendFactors multiply by.
inherited
setCullMode(CullMode mode) → void
inherited
setDepthCompare(CompareFunction compare) → void
inherited
setDepthWrite(bool enabled) → void
inherited
setPolygonMode(PolygonMode mode) → void
Filled or drawn as edges. Ask GraphicsDevice.supportsWireframe before naming PolygonMode.line: a backend that cannot draw it throws an UnsupportedError rather than filling.
inherited
setPrimitiveType(PrimitiveType type) → void
How the following draws assemble their vertices.
inherited
setScissor(ScreenRect rect) → void
Where fragments survive. Bounds a draw, and — unlike a clear — is honoured by one.
inherited
setState(PassState state) → void

Available on PassEncoder, provided by the PassStateApply extension

Emits one call per field state sets, and nothing for the rest.
setStencil(StencilState front, {StencilState? back}) → void
The stencil test for the draws that follow.
inherited
setStencilReference(int value) → void
The value the stencil test compares against and StencilOperation.setToReferenceValue stores. Eight bits; zero until set.
inherited
setViewport(ScreenRect rect) → void
Where the rasteriser may write.
inherited
setWindingOrder(WindingOrder order) → void
inherited
submit() → void
Ends the pass and hands it to the queue.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited