Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    CommandList Class

    Namespace: Stride.Graphics
    Assembly: Stride.Graphics.dll

    Performs resource bindings and primitive-based rendering. See the GraphicsDevice class to learn more about the class.

    System.Object → DisposeBase → ComponentBase → GraphicsResourceBase → CommandList
    Derived from CommandList:

    public class CommandList : GraphicsResourceBase, IDisposable, IComponent, IReferencable, ICollectorHolder
    Name Description
    Properties
    DepthStencilBuffer

    Gets the depth stencil buffer currently sets on this instance.

    RenderTarget

    Gets the render target buffer currently sets on this instance.

    RenderTargetCount
    RenderTargets
    Scissor

    Gets the first scissor.

    Viewport

    Gets the first viewport.

    ViewportCount
    Viewports
    Methods
    BeginProfile(Color4, String)

    Begins debug event.

    Clear(Texture, Color4)

    Clears the specified render target. See to learn how to use it.

    Clear(Texture, DepthStencilClearOptions, Single, Byte)

    Clears the specified depth stencil buffer. See to learn how to use it.

    ClearReadWrite(Buffer, Int4)

    Clears a read-write Buffer. This buffer must have been created with read-write/unordered access.

    ClearReadWrite(Buffer, UInt4)

    Clears a read-write Buffer. This buffer must have been created with read-write/unordered access.

    ClearReadWrite(Buffer, Vector4)

    Clears a read-write Buffer. This buffer must have been created with read-write/unordered access.

    ClearReadWrite(Texture, Int4)

    Clears a read-write Texture. This texture must have been created with read-write/unordered access.

    ClearReadWrite(Texture, UInt4)

    Clears a read-write Texture. This texture must have been created with read-write/unordered access.

    ClearReadWrite(Texture, Vector4)

    Clears a read-write Texture. This texture must have been created with read-write/unordered access.

    ClearState()

    Clears the state and restore the state of the device.

    Close()
    Copy(GraphicsResource, GraphicsResource)

    Copy a texture. View is ignored and full underlying texture is copied.

    CopyCount(Buffer, Buffer, Int32)
    CopyMultisample(Texture, Int32, Texture, Int32, PixelFormat)
    CopyRegion(GraphicsResource, Int32, Nullable<ResourceRegion>, GraphicsResource, Int32, Int32, Int32, Int32)
    Dispatch(Buffer, Int32)

    Dispatches the specified indirect buffer.

    Dispatch(Int32, Int32, Int32)
    Draw(Int32, Int32)

    Draw non-indexed, non-instanced primitives.

    DrawAuto()

    Draw geometry of an unknown size.

    DrawIndexed(Int32, Int32, Int32)

    Draw indexed, non-instanced primitives.

    DrawIndexedInstanced(Buffer, Int32)

    Draw indexed, instanced, GPU-generated primitives.

    DrawIndexedInstanced(Int32, Int32, Int32, Int32, Int32)

    Draw indexed, instanced primitives.

    DrawInstanced(Buffer, Int32)

    Draw instanced, GPU-generated primitives.

    DrawInstanced(Int32, Int32, Int32, Int32)

    Draw non-indexed, instanced primitives.

    EndProfile()

    Ends debug event.

    Flush()
    MapSubresource(GraphicsResource, Int32, MapMode, Boolean, Int32, Int32)

    Maps a subresource.

    New(GraphicsDevice)
    OnDestroyed()

    Called when graphics device has been detected to be internally destroyed.

    Reset()
    ResetTargets()

    Unbinds all depth-stencil buffer and render targets from the output-merger stage.

    ResourceBarrierTransition(GraphicsResource, GraphicsResourceState)
    SetBlendFactor(Color4)
    SetDescriptorSets(Int32, DescriptorSet[])
    SetIndexBuffer(Buffer, Int32, Boolean)
    SetPipelineState(PipelineState)
    SetRenderTarget(Texture, Texture)

    Binds a depth-stencil buffer and a single render target to the output-merger stage. See to learn how to use it.

    SetRenderTargetAndViewport(Texture, Texture)

    Binds a depth-stencil buffer and a single render target to the output-merger stage. See to learn how to use it.

    SetRenderTargetAndViewport(Texture, Texture, Texture)
    SetRenderTargets(Texture, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    SetRenderTargets(Texture, Int32, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    SetRenderTargets(Texture[])

    Bind one or more render targets atomically and the depth-stencil buffer to the output-merger stage. See to learn how to use it.

    SetRenderTargetsAndViewport(Texture, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    SetRenderTargetsAndViewport(Texture, Int32, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    SetRenderTargetsAndViewport(Texture[])

    Bind one or more render targets atomically and the depth-stencil buffer to the output-merger stage. See to learn how to use it.

    SetScissorRectangle(Rectangle)

    Binds a single scissor rectangle to the rasterizer stage. See to learn how to use it.

    SetScissorRectangles(Rectangle[])

    Binds a set of scissor rectangles to the rasterizer stage. See to learn how to use it.

    SetScissorRectangles(Int32, Rectangle[])

    Binds a set of scissor rectangles to the rasterizer stage. See to learn how to use it.

    SetStencilReference(Int32)
    SetStreamTargets(Buffer[])

    Sets the stream targets.

    SetVertexBuffer(Int32, Buffer, Int32, Int32)
    SetViewport(Viewport)

    Sets a viewport.

    SetViewports(Viewport[])

    Sets the viewports.

    SetViewports(Int32, Viewport[])

    Sets the viewports.

    UnmapSubresource(MappedResource)
    UnsetRenderTargets()

    Unsets the render targets.

    WriteTimestamp(QueryPool, Int32)

    Submits a GPU timestamp query.

    | Improve this Doc View Source

    Properties


    DepthStencilBuffer

    Gets the depth stencil buffer currently sets on this instance.

    public Texture DepthStencilBuffer { get; }
    Property Value
    Type Description
    Texture

    The depth stencil buffer currently sets on this instance.


    RenderTarget

    Gets the render target buffer currently sets on this instance.

    public Texture RenderTarget { get; }
    Property Value
    Type Description
    Texture

    The render target buffer currently sets on this instance.


    RenderTargetCount

    public int RenderTargetCount { get; }
    Property Value
    Type Description
    System.Int32

    RenderTargets

    public Texture[] RenderTargets { get; }
    Property Value
    Type Description
    Texture[]

    Scissor

    Gets the first scissor.

    public Rectangle Scissor { get; }
    Property Value
    Type Description
    Rectangle

    The first scissor.


    Viewport

    Gets the first viewport.

    public Viewport Viewport { get; }
    Property Value
    Type Description
    Viewport

    The first viewport.


    ViewportCount

    public int ViewportCount { get; }
    Property Value
    Type Description
    System.Int32

    Viewports

    public Viewport[] Viewports { get; }
    Property Value
    Type Description
    Viewport[]
    | Improve this Doc View Source

    Methods


    BeginProfile(Color4, String)

    Begins debug event.

    public void BeginProfile(Color4 profileColor, string name)
    Parameters
    Type Name Description
    Color4 profileColor

    Color of the profile.

    System.String name

    The name.


    Clear(Texture, Color4)

    Clears the specified render target. See to learn how to use it.

    public void Clear(Texture renderTarget, Color4 color)
    Parameters
    Type Name Description
    Texture renderTarget

    The render target.

    Color4 color

    The color.

    Exceptions
    Type Condition
    System.ArgumentNullException

    renderTarget


    Clear(Texture, DepthStencilClearOptions, Single, Byte)

    Clears the specified depth stencil buffer. See to learn how to use it.

    public void Clear(Texture depthStencilBuffer, DepthStencilClearOptions options, float depth = 1F, byte stencil = 0)
    Parameters
    Type Name Description
    Texture depthStencilBuffer

    The depth stencil buffer.

    DepthStencilClearOptions options

    The options.

    System.Single depth

    The depth.

    System.Byte stencil

    The stencil.

    Exceptions
    Type Condition
    System.InvalidOperationException

    ClearReadWrite(Buffer, Int4)

    Clears a read-write Buffer. This buffer must have been created with read-write/unordered access.

    public void ClearReadWrite(Buffer buffer, Int4 value)
    Parameters
    Type Name Description
    Buffer buffer

    The buffer.

    Int4 value

    The value.

    Exceptions
    Type Condition
    System.ArgumentNullException

    buffer

    System.ArgumentException

    Expecting buffer supporting UAV;buffer


    ClearReadWrite(Buffer, UInt4)

    Clears a read-write Buffer. This buffer must have been created with read-write/unordered access.

    public void ClearReadWrite(Buffer buffer, UInt4 value)
    Parameters
    Type Name Description
    Buffer buffer

    The buffer.

    UInt4 value

    The value.

    Exceptions
    Type Condition
    System.ArgumentNullException

    buffer

    System.ArgumentException

    Expecting buffer supporting UAV;buffer


    ClearReadWrite(Buffer, Vector4)

    Clears a read-write Buffer. This buffer must have been created with read-write/unordered access.

    public void ClearReadWrite(Buffer buffer, Vector4 value)
    Parameters
    Type Name Description
    Buffer buffer

    The buffer.

    Vector4 value

    The value.

    Exceptions
    Type Condition
    System.ArgumentNullException

    buffer

    System.ArgumentException

    Expecting buffer supporting UAV;buffer


    ClearReadWrite(Texture, Int4)

    Clears a read-write Texture. This texture must have been created with read-write/unordered access.

    public void ClearReadWrite(Texture texture, Int4 value)
    Parameters
    Type Name Description
    Texture texture

    The texture.

    Int4 value

    The value.

    Exceptions
    Type Condition
    System.ArgumentNullException

    texture

    System.ArgumentException

    Expecting texture supporting UAV;texture


    ClearReadWrite(Texture, UInt4)

    Clears a read-write Texture. This texture must have been created with read-write/unordered access.

    public void ClearReadWrite(Texture texture, UInt4 value)
    Parameters
    Type Name Description
    Texture texture

    The texture.

    UInt4 value

    The value.

    Exceptions
    Type Condition
    System.ArgumentNullException

    texture

    System.ArgumentException

    Expecting texture supporting UAV;texture


    ClearReadWrite(Texture, Vector4)

    Clears a read-write Texture. This texture must have been created with read-write/unordered access.

    public void ClearReadWrite(Texture texture, Vector4 value)
    Parameters
    Type Name Description
    Texture texture

    The texture.

    Vector4 value

    The value.

    Exceptions
    Type Condition
    System.ArgumentNullException

    texture

    System.ArgumentException

    Expecting texture supporting UAV;texture


    ClearState()

    Clears the state and restore the state of the device.

    public void ClearState()

    Close()

    public CompiledCommandList Close()
    Returns
    Type Description
    CompiledCommandList

    Copy(GraphicsResource, GraphicsResource)

    Copy a texture. View is ignored and full underlying texture is copied.

    public void Copy(GraphicsResource source, GraphicsResource destination)
    Parameters
    Type Name Description
    GraphicsResource source

    The source texture.

    GraphicsResource destination

    The destination texture.


    CopyCount(Buffer, Buffer, Int32)

    public void CopyCount(Buffer sourceBuffer, Buffer destBuffer, int offsetInBytes)
    Parameters
    Type Name Description
    Buffer sourceBuffer
    Buffer destBuffer
    System.Int32 offsetInBytes

    CopyMultisample(Texture, Int32, Texture, Int32, PixelFormat)

    public void CopyMultisample(Texture sourceMultisampleTexture, int sourceSubResource, Texture destTexture, int destSubResource, PixelFormat format = PixelFormat.None)
    Parameters
    Type Name Description
    Texture sourceMultisampleTexture
    System.Int32 sourceSubResource
    Texture destTexture
    System.Int32 destSubResource
    PixelFormat format

    CopyRegion(GraphicsResource, Int32, Nullable<ResourceRegion>, GraphicsResource, Int32, Int32, Int32, Int32)

    public void CopyRegion(GraphicsResource source, int sourceSubresource, ResourceRegion? sourecRegion, GraphicsResource destination, int destinationSubResource, int dstX = 0, int dstY = 0, int dstZ = 0)
    Parameters
    Type Name Description
    GraphicsResource source
    System.Int32 sourceSubresource
    System.Nullable<ResourceRegion> sourecRegion
    GraphicsResource destination
    System.Int32 destinationSubResource
    System.Int32 dstX
    System.Int32 dstY
    System.Int32 dstZ

    Dispatch(Buffer, Int32)

    Dispatches the specified indirect buffer.

    public void Dispatch(Buffer indirectBuffer, int offsetInBytes)
    Parameters
    Type Name Description
    Buffer indirectBuffer

    The indirect buffer.

    System.Int32 offsetInBytes

    The offset information bytes.


    Dispatch(Int32, Int32, Int32)

    public void Dispatch(int threadCountX, int threadCountY, int threadCountZ)
    Parameters
    Type Name Description
    System.Int32 threadCountX
    System.Int32 threadCountY
    System.Int32 threadCountZ

    Draw(Int32, Int32)

    Draw non-indexed, non-instanced primitives.

    public void Draw(int vertexCount, int startVertexLocation = 0)
    Parameters
    Type Name Description
    System.Int32 vertexCount

    Number of vertices to draw.

    System.Int32 startVertexLocation

    Index of the first vertex, which is usually an offset in a vertex buffer; it could also be used as the first vertex id generated for a shader parameter marked with the SV_TargetId system-value semantic.


    DrawAuto()

    Draw geometry of an unknown size.

    public void DrawAuto()

    DrawIndexed(Int32, Int32, Int32)

    Draw indexed, non-instanced primitives.

    public void DrawIndexed(int indexCount, int startIndexLocation = 0, int baseVertexLocation = 0)
    Parameters
    Type Name Description
    System.Int32 indexCount

    Number of indices to draw.

    System.Int32 startIndexLocation

    The location of the first index read by the GPU from the index buffer.

    System.Int32 baseVertexLocation

    A value added to each index before reading a vertex from the vertex buffer.


    DrawIndexedInstanced(Buffer, Int32)

    Draw indexed, instanced, GPU-generated primitives.

    public void DrawIndexedInstanced(Buffer argumentsBuffer, int alignedByteOffsetForArgs = 0)
    Parameters
    Type Name Description
    Buffer argumentsBuffer

    A buffer containing the GPU generated primitives.

    System.Int32 alignedByteOffsetForArgs

    Offset in pBufferForArgs to the start of the GPU generated primitives.


    DrawIndexedInstanced(Int32, Int32, Int32, Int32, Int32)

    Draw indexed, instanced primitives.

    public void DrawIndexedInstanced(int indexCountPerInstance, int instanceCount, int startIndexLocation = 0, int baseVertexLocation = 0, int startInstanceLocation = 0)
    Parameters
    Type Name Description
    System.Int32 indexCountPerInstance

    Number of indices read from the index buffer for each instance.

    System.Int32 instanceCount

    Number of instances to draw.

    System.Int32 startIndexLocation

    The location of the first index read by the GPU from the index buffer.

    System.Int32 baseVertexLocation

    A value added to each index before reading a vertex from the vertex buffer.

    System.Int32 startInstanceLocation

    A value added to each index before reading per-instance data from a vertex buffer.


    DrawInstanced(Buffer, Int32)

    Draw instanced, GPU-generated primitives.

    public void DrawInstanced(Buffer argumentsBuffer, int alignedByteOffsetForArgs = 0)
    Parameters
    Type Name Description
    Buffer argumentsBuffer

    An arguments buffer

    System.Int32 alignedByteOffsetForArgs

    Offset in pBufferForArgs to the start of the GPU generated primitives.


    DrawInstanced(Int32, Int32, Int32, Int32)

    Draw non-indexed, instanced primitives.

    public void DrawInstanced(int vertexCountPerInstance, int instanceCount, int startVertexLocation = 0, int startInstanceLocation = 0)
    Parameters
    Type Name Description
    System.Int32 vertexCountPerInstance

    Number of vertices to draw.

    System.Int32 instanceCount

    Number of instances to draw.

    System.Int32 startVertexLocation

    Index of the first vertex.

    System.Int32 startInstanceLocation

    A value added to each index before reading per-instance data from a vertex buffer.


    EndProfile()

    Ends debug event.

    public void EndProfile()

    Flush()

    public void Flush()

    MapSubresource(GraphicsResource, Int32, MapMode, Boolean, Int32, Int32)

    Maps a subresource.

    public MappedResource MapSubresource(GraphicsResource resource, int subResourceIndex, MapMode mapMode, bool doNotWait = false, int offsetInBytes = 0, int lengthInBytes = 0)
    Parameters
    Type Name Description
    GraphicsResource resource

    The resource.

    System.Int32 subResourceIndex

    Index of the sub resource.

    MapMode mapMode

    The map mode.

    System.Boolean doNotWait

    if set to true this method will return immediately if the resource is still being used by the GPU for writing. Default is false

    System.Int32 offsetInBytes

    The offset information in bytes.

    System.Int32 lengthInBytes

    The length information in bytes.

    Returns
    Type Description
    MappedResource

    Pointer to the sub resource to map.


    New(GraphicsDevice)

    public static CommandList New(GraphicsDevice device)
    Parameters
    Type Name Description
    GraphicsDevice device
    Returns
    Type Description
    CommandList

    OnDestroyed()

    Called when graphics device has been detected to be internally destroyed.

    protected override void OnDestroyed()
    Overrides
    GraphicsResourceBase.OnDestroyed()

    Reset()

    public void Reset()

    ResetTargets()

    Unbinds all depth-stencil buffer and render targets from the output-merger stage.

    public void ResetTargets()

    ResourceBarrierTransition(GraphicsResource, GraphicsResourceState)

    public void ResourceBarrierTransition(GraphicsResource resource, GraphicsResourceState newState)
    Parameters
    Type Name Description
    GraphicsResource resource
    GraphicsResourceState newState

    SetBlendFactor(Color4)

    public void SetBlendFactor(Color4 blendFactor)
    Parameters
    Type Name Description
    Color4 blendFactor

    SetDescriptorSets(Int32, DescriptorSet[])

    public void SetDescriptorSets(int index, DescriptorSet[] descriptorSets)
    Parameters
    Type Name Description
    System.Int32 index
    DescriptorSet[] descriptorSets

    SetIndexBuffer(Buffer, Int32, Boolean)

    public void SetIndexBuffer(Buffer buffer, int offset, bool is32bits)
    Parameters
    Type Name Description
    Buffer buffer
    System.Int32 offset
    System.Boolean is32bits

    SetPipelineState(PipelineState)

    public void SetPipelineState(PipelineState pipelineState)
    Parameters
    Type Name Description
    PipelineState pipelineState

    SetRenderTarget(Texture, Texture)

    Binds a depth-stencil buffer and a single render target to the output-merger stage. See to learn how to use it.

    public void SetRenderTarget(Texture depthStencilView, Texture renderTargetView)
    Parameters
    Type Name Description
    Texture depthStencilView

    A view of the depth-stencil buffer to bind.

    Texture renderTargetView

    A view of the render target to bind.


    SetRenderTargetAndViewport(Texture, Texture)

    Binds a depth-stencil buffer and a single render target to the output-merger stage. See to learn how to use it.

    public void SetRenderTargetAndViewport(Texture depthStencilView, Texture renderTargetView)
    Parameters
    Type Name Description
    Texture depthStencilView

    A view of the depth-stencil buffer to bind.

    Texture renderTargetView

    A view of the render target to bind.


    SetRenderTargetAndViewport(Texture, Texture, Texture)

    public void SetRenderTargetAndViewport(Texture depthStencilView, Texture renderTargetView, Texture secondRenderTarget)
    Parameters
    Type Name Description
    Texture depthStencilView
    Texture renderTargetView
    Texture secondRenderTarget

    SetRenderTargets(Texture, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    public void SetRenderTargets(Texture depthStencilView, Texture[] renderTargetViews)
    Parameters
    Type Name Description
    Texture depthStencilView

    A view of the depth-stencil buffer to bind.

    Texture[] renderTargetViews

    A set of render target views to bind.

    Exceptions
    Type Condition
    System.ArgumentNullException

    renderTargetViews


    SetRenderTargets(Texture, Int32, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    public void SetRenderTargets(Texture depthStencilView, int renderTargetViewCount, Texture[] renderTargetViews)
    Parameters
    Type Name Description
    Texture depthStencilView

    A view of the depth-stencil buffer to bind.

    System.Int32 renderTargetViewCount

    The number of render target in renderTargetViews.

    Texture[] renderTargetViews

    A set of render target views to bind.

    Exceptions
    Type Condition
    System.ArgumentNullException

    renderTargetViews


    SetRenderTargets(Texture[])

    Bind one or more render targets atomically and the depth-stencil buffer to the output-merger stage. See to learn how to use it.

    public void SetRenderTargets(Texture[] renderTargetViews)
    Parameters
    Type Name Description
    Texture[] renderTargetViews

    A set of render target views to bind.


    SetRenderTargetsAndViewport(Texture, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    public void SetRenderTargetsAndViewport(Texture depthStencilView, Texture[] renderTargetViews)
    Parameters
    Type Name Description
    Texture depthStencilView

    A view of the depth-stencil buffer to bind.

    Texture[] renderTargetViews

    A set of render target views to bind.

    Exceptions
    Type Condition
    System.ArgumentNullException

    renderTargetViews


    SetRenderTargetsAndViewport(Texture, Int32, Texture[])

    Binds a depth-stencil buffer and a set of render targets to the output-merger stage. See to learn how to use it.

    public void SetRenderTargetsAndViewport(Texture depthStencilView, int renderTargetViewCount, Texture[] renderTargetViews)
    Parameters
    Type Name Description
    Texture depthStencilView

    A view of the depth-stencil buffer to bind.

    System.Int32 renderTargetViewCount

    The number of render target in renderTargetViews.

    Texture[] renderTargetViews

    A set of render target views to bind.

    Exceptions
    Type Condition
    System.ArgumentNullException

    renderTargetViews


    SetRenderTargetsAndViewport(Texture[])

    Bind one or more render targets atomically and the depth-stencil buffer to the output-merger stage. See to learn how to use it.

    public void SetRenderTargetsAndViewport(Texture[] renderTargetViews)
    Parameters
    Type Name Description
    Texture[] renderTargetViews

    A set of render target views to bind.


    SetScissorRectangle(Rectangle)

    Binds a single scissor rectangle to the rasterizer stage. See to learn how to use it.

    public void SetScissorRectangle(Rectangle rectangle)
    Parameters
    Type Name Description
    Rectangle rectangle

    The scissor rectangle.


    SetScissorRectangles(Rectangle[])

    Binds a set of scissor rectangles to the rasterizer stage. See to learn how to use it.

    public void SetScissorRectangles(Rectangle[] scissorRectangles)
    Parameters
    Type Name Description
    Rectangle[] scissorRectangles

    The set of scissor rectangles to bind.


    SetScissorRectangles(Int32, Rectangle[])

    Binds a set of scissor rectangles to the rasterizer stage. See to learn how to use it.

    public void SetScissorRectangles(int scissorCount, Rectangle[] scissorRectangles)
    Parameters
    Type Name Description
    System.Int32 scissorCount

    The number of scissor rectangles to bind.

    Rectangle[] scissorRectangles

    The set of scissor rectangles to bind.


    SetStencilReference(Int32)

    public void SetStencilReference(int stencilReference)
    Parameters
    Type Name Description
    System.Int32 stencilReference

    SetStreamTargets(Buffer[])

    Sets the stream targets.

    public void SetStreamTargets(params Buffer[] buffers)
    Parameters
    Type Name Description
    Buffer[] buffers

    The buffers.


    SetVertexBuffer(Int32, Buffer, Int32, Int32)

    public void SetVertexBuffer(int index, Buffer buffer, int offset, int stride)
    Parameters
    Type Name Description
    System.Int32 index
    Buffer buffer
    System.Int32 offset
    System.Int32 stride

    SetViewport(Viewport)

    Sets a viewport.

    public void SetViewport(Viewport value)
    Parameters
    Type Name Description
    Viewport value

    SetViewports(Viewport[])

    Sets the viewports.

    public void SetViewports(Viewport[] values)
    Parameters
    Type Name Description
    Viewport[] values

    SetViewports(Int32, Viewport[])

    Sets the viewports.

    public void SetViewports(int viewportCount, Viewport[] values)
    Parameters
    Type Name Description
    System.Int32 viewportCount
    Viewport[] values

    UnmapSubresource(MappedResource)

    public void UnmapSubresource(MappedResource unmapped)
    Parameters
    Type Name Description
    MappedResource unmapped

    UnsetRenderTargets()

    Unsets the render targets.

    public void UnsetRenderTargets()

    WriteTimestamp(QueryPool, Int32)

    Submits a GPU timestamp query.

    public void WriteTimestamp(QueryPool queryPool, int index)
    Parameters
    Type Name Description
    QueryPool queryPool

    The QueryPool owning the query.

    System.Int32 index

    The query index.


    Inherited Members

    GraphicsResourceBase.NativeResource
    GraphicsResourceBase.NativeDeviceChild
    GraphicsResourceBase.OnRecreate()
    GraphicsResourceBase.NativeDevice
    GraphicsResourceBase.Reload
    GraphicsResourceBase.GraphicsDevice
    GraphicsResourceBase.Destroyed
    GraphicsResourceBase.OnPause()
    GraphicsResourceBase.OnResume()
    GraphicsResourceBase.Destroy()
    ComponentBase.Tags
    ComponentBase.Name
    ComponentBase.ICollectorHolder.Collector
    ComponentBase.OnNameChanged()
    ComponentBase.ToString()
    DisposeBase.Dispose()
    DisposeBase.IsDisposed
    DisposeBase.IReferencable.ReferenceCount
    DisposeBase.IReferencable.AddReference()
    DisposeBase.IReferencable.Release()
    DisposeBase.OnAddReference()
    DisposeBase.OnReleaseReference()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    GraphicsDeviceExtensions.DrawQuad(CommandList)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation