Struct CommandBuffer

Namespace

SharpVulkan

Assembly

Lime.dll

public struct CommandBuffer : IEquatable<CommandBuffer>

Implements

IEquatable<CommandBuffer>

Inherited Members

ValueType.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

Null

public static readonly CommandBuffer Null

Field Value

CommandBuffer

Methods

Begin(ref CommandBufferBeginInfo)

public void Begin(ref CommandBufferBeginInfo beginInfo)

Parameters

beginInfo CommandBufferBeginInfo

BeginQuery(QueryPool, uint, QueryControlFlags)

public void BeginQuery(QueryPool queryPool, uint query, QueryControlFlags flags)

Parameters

queryPool QueryPool

query uint

flags QueryControlFlags

BeginRenderPass(ref RenderPassBeginInfo, SubpassContents)

public void BeginRenderPass(ref RenderPassBeginInfo renderPassBegin, SubpassContents contents)

Parameters

renderPassBegin RenderPassBeginInfo

contents SubpassContents

BindDescriptorSets(PipelineBindPoint, PipelineLayout, uint, uint, DescriptorSet*, uint, uint*)

public void BindDescriptorSets(PipelineBindPoint pipelineBindPoint, PipelineLayout layout, uint firstSet, uint descriptorSetCount, DescriptorSet* descriptorSets, uint dynamicOffsetCount, uint* dynamicOffsets)

Parameters

pipelineBindPoint PipelineBindPoint

layout PipelineLayout

firstSet uint

descriptorSetCount uint

descriptorSets DescriptorSet*

dynamicOffsetCount uint

dynamicOffsets uint*

BindIndexBuffer(Buffer, ulong, IndexType)

public void BindIndexBuffer(Buffer buffer, ulong offset, IndexType indexType)

Parameters

buffer Buffer

offset ulong

indexType IndexType

BindPipeline(PipelineBindPoint, Pipeline)

public void BindPipeline(PipelineBindPoint pipelineBindPoint, Pipeline pipeline)

Parameters

pipelineBindPoint PipelineBindPoint

pipeline Pipeline

BindVertexBuffers(uint, uint, Buffer*, ulong*)

public void BindVertexBuffers(uint firstBinding, uint bindingCount, Buffer* buffers, ulong* offsets)

Parameters

firstBinding uint

bindingCount uint

buffers Buffer*

offsets ulong*

BlitImage(Image, ImageLayout, Image, ImageLayout, uint, ImageBlit*, Filter)

public void BlitImage(Image sourceImage, ImageLayout sourceImageLayout, Image destinationImage, ImageLayout destinationImageLayout, uint regionCount, ImageBlit* regions, Filter filter)

Parameters

sourceImage Image

sourceImageLayout ImageLayout

destinationImage Image

destinationImageLayout ImageLayout

regionCount uint

regions ImageBlit*

filter Filter

ClearAttachments(uint, ref ClearAttachment, uint, ClearRect*)

public void ClearAttachments(uint attachmentCount, ref ClearAttachment attachments, uint rectCount, ClearRect* rects)

Parameters

attachmentCount uint

attachments ClearAttachment

rectCount uint

rects ClearRect*

ClearColorImage(Image, ImageLayout, ClearColorValue, uint, ImageSubresourceRange*)

public void ClearColorImage(Image image, ImageLayout imageLayout, ClearColorValue color, uint rangeCount, ImageSubresourceRange* ranges)

Parameters

image Image

imageLayout ImageLayout

color ClearColorValue

rangeCount uint

ranges ImageSubresourceRange*

ClearDepthStencilImage(Image, ImageLayout, ClearDepthStencilValue, uint, ImageSubresourceRange*)

public void ClearDepthStencilImage(Image image, ImageLayout imageLayout, ClearDepthStencilValue depthStencil, uint rangeCount, ImageSubresourceRange* ranges)

Parameters

image Image

imageLayout ImageLayout

depthStencil ClearDepthStencilValue

rangeCount uint

ranges ImageSubresourceRange*

CopyBuffer(Buffer, Buffer, uint, BufferCopy*)

public void CopyBuffer(Buffer sourceBuffer, Buffer destinationBuffer, uint regionCount, BufferCopy* regions)

Parameters

sourceBuffer Buffer

destinationBuffer Buffer

regionCount uint

regions BufferCopy*

CopyBufferToImage(Buffer, Image, ImageLayout, uint, BufferImageCopy*)

public void CopyBufferToImage(Buffer sourceBuffer, Image destinationImage, ImageLayout destinationImageLayout, uint regionCount, BufferImageCopy* regions)

Parameters

sourceBuffer Buffer

destinationImage Image

destinationImageLayout ImageLayout

regionCount uint

regions BufferImageCopy*

CopyImage(Image, ImageLayout, Image, ImageLayout, uint, ImageCopy*)

public void CopyImage(Image sourceImage, ImageLayout sourceImageLayout, Image destinationImage, ImageLayout destinationImageLayout, uint regionCount, ImageCopy* regions)

Parameters

sourceImage Image

sourceImageLayout ImageLayout

destinationImage Image

destinationImageLayout ImageLayout

regionCount uint

regions ImageCopy*

CopyImageToBuffer(Image, ImageLayout, Buffer, uint, BufferImageCopy*)

public void CopyImageToBuffer(Image sourceImage, ImageLayout sourceImageLayout, Buffer destinationBuffer, uint regionCount, BufferImageCopy* regions)

Parameters

sourceImage Image

sourceImageLayout ImageLayout

destinationBuffer Buffer

regionCount uint

regions BufferImageCopy*

CopyQueryPoolResults(QueryPool, uint, uint, Buffer, ulong, ulong, QueryResultFlags)

public void CopyQueryPoolResults(QueryPool queryPool, uint firstQuery, uint queryCount, Buffer destinationBuffer, ulong destinationOffset, ulong stride, QueryResultFlags flags)

Parameters

queryPool QueryPool

firstQuery uint

queryCount uint

destinationBuffer Buffer

destinationOffset ulong

stride ulong

flags QueryResultFlags

DebugMarkerBegin(ref DebugMarkerMarkerInfo)

public void DebugMarkerBegin(ref DebugMarkerMarkerInfo markerInfo)

Parameters

markerInfo DebugMarkerMarkerInfo

DebugMarkerEnd()

public void DebugMarkerEnd()

DebugMarkerInsert(ref DebugMarkerMarkerInfo)

public void DebugMarkerInsert(ref DebugMarkerMarkerInfo markerInfo)

Parameters

markerInfo DebugMarkerMarkerInfo

Dispatch(uint, uint, uint)

public void Dispatch(uint x, uint y, uint z)

Parameters

x uint

y uint

z uint

DispatchIndirect(Buffer, ulong)

public void DispatchIndirect(Buffer buffer, ulong offset)

Parameters

buffer Buffer

offset ulong

Draw(uint, uint, uint, uint)

public void Draw(uint vertexCount, uint instanceCount, uint firstVertex, uint firstInstance)

Parameters

vertexCount uint

instanceCount uint

firstVertex uint

firstInstance uint

DrawIndexed(uint, uint, uint, int, uint)

public void DrawIndexed(uint indexCount, uint instanceCount, uint firstIndex, int vertexOffset, uint firstInstance)

Parameters

indexCount uint

instanceCount uint

firstIndex uint

vertexOffset int

firstInstance uint

DrawIndexedIndirect(Buffer, ulong, uint, uint)

public void DrawIndexedIndirect(Buffer buffer, ulong offset, uint drawCount, uint stride)

Parameters

buffer Buffer

offset ulong

drawCount uint

stride uint

DrawIndexedIndirectCount(Buffer, ulong, Buffer, ulong, uint, uint)

public void DrawIndexedIndirectCount(Buffer buffer, ulong offset, Buffer countBuffer, ulong countBufferOffset, uint maxDrawCount, uint stride)

Parameters

buffer Buffer

offset ulong

countBuffer Buffer

countBufferOffset ulong

maxDrawCount uint

stride uint

DrawIndirect(Buffer, ulong, uint, uint)

public void DrawIndirect(Buffer buffer, ulong offset, uint drawCount, uint stride)

Parameters

buffer Buffer

offset ulong

drawCount uint

stride uint

DrawIndirectCount(Buffer, ulong, Buffer, ulong, uint, uint)

public void DrawIndirectCount(Buffer buffer, ulong offset, Buffer countBuffer, ulong countBufferOffset, uint maxDrawCount, uint stride)

Parameters

buffer Buffer

offset ulong

countBuffer Buffer

countBufferOffset ulong

maxDrawCount uint

stride uint

End()

public void End()

EndQuery(QueryPool, uint)

public void EndQuery(QueryPool queryPool, uint query)

Parameters

queryPool QueryPool

query uint

EndRenderPass()

public void EndRenderPass()

Equals(CommandBuffer)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(CommandBuffer other)

Parameters

other CommandBuffer

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

ExecuteCommands(uint, CommandBuffer*)

public void ExecuteCommands(uint commandBufferCount, CommandBuffer* commandBuffers)

Parameters

commandBufferCount uint

commandBuffers CommandBuffer*

FillBuffer(Buffer, ulong, ulong, uint)

public void FillBuffer(Buffer destinationBuffer, ulong destinationOffset, ulong size, uint data)

Parameters

destinationBuffer Buffer

destinationOffset ulong

size ulong

data uint

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

NextSubpass(SubpassContents)

public void NextSubpass(SubpassContents contents)

Parameters

contents SubpassContents

PipelineBarrier(PipelineStageFlags, PipelineStageFlags, DependencyFlags, uint, MemoryBarrier*, uint, BufferMemoryBarrier*, uint, ImageMemoryBarrier*)

public void PipelineBarrier(PipelineStageFlags sourceStageMask, PipelineStageFlags destinationStageMask, DependencyFlags dependencyFlags, uint memoryBarrierCount, MemoryBarrier* memoryBarriers, uint bufferMemoryBarrierCount, BufferMemoryBarrier* bufferMemoryBarriers, uint imageMemoryBarrierCount, ImageMemoryBarrier* imageMemoryBarriers)

Parameters

sourceStageMask PipelineStageFlags

destinationStageMask PipelineStageFlags

dependencyFlags DependencyFlags

memoryBarrierCount uint

memoryBarriers MemoryBarrier*

bufferMemoryBarrierCount uint

bufferMemoryBarriers BufferMemoryBarrier*

imageMemoryBarrierCount uint

imageMemoryBarriers ImageMemoryBarrier*

ProcessCommands(ref CommandProcessCommandsInfo)

public void ProcessCommands(ref CommandProcessCommandsInfo processCommandsInfo)

Parameters

processCommandsInfo CommandProcessCommandsInfo

PushConstants(PipelineLayout, ShaderStageFlags, uint, uint, nint)

public void PushConstants(PipelineLayout layout, ShaderStageFlags stageFlags, uint offset, uint size, nint values)

Parameters

layout PipelineLayout

stageFlags ShaderStageFlags

offset uint

size uint

values nint

ReserveSpaceForCommands(ref CommandReserveSpaceForCommandsInfo)

public void ReserveSpaceForCommands(ref CommandReserveSpaceForCommandsInfo reserveSpaceInfo)

Parameters

reserveSpaceInfo CommandReserveSpaceForCommandsInfo

Reset(CommandBufferResetFlags)

public void Reset(CommandBufferResetFlags flags)

Parameters

flags CommandBufferResetFlags

ResetEvent(Event, PipelineStageFlags)

public void ResetEvent(Event @event, PipelineStageFlags stageMask)

Parameters

event Event

stageMask PipelineStageFlags

ResetQueryPool(QueryPool, uint, uint)

public void ResetQueryPool(QueryPool queryPool, uint firstQuery, uint queryCount)

Parameters

queryPool QueryPool

firstQuery uint

queryCount uint

ResolveImage(Image, ImageLayout, Image, ImageLayout, uint, ImageResolve*)

public void ResolveImage(Image sourceImage, ImageLayout sourceImageLayout, Image destinationImage, ImageLayout destinationImageLayout, uint regionCount, ImageResolve* regions)

Parameters

sourceImage Image

sourceImageLayout ImageLayout

destinationImage Image

destinationImageLayout ImageLayout

regionCount uint

regions ImageResolve*

SetBlendConstants(float)

public void SetBlendConstants(float blendConstants)

Parameters

blendConstants float

SetDepthBias(float, float, float)

public void SetDepthBias(float depthBiasConstantFactor, float depthBiasClamp, float depthBiasSlopeFactor)

Parameters

depthBiasConstantFactor float

depthBiasClamp float

depthBiasSlopeFactor float

SetDepthBounds(float, float)

public void SetDepthBounds(float minDepthBounds, float maxDepthBounds)

Parameters

minDepthBounds float

maxDepthBounds float

SetEvent(Event, PipelineStageFlags)

public void SetEvent(Event @event, PipelineStageFlags stageMask)

Parameters

event Event

stageMask PipelineStageFlags

SetLineWidth(float)

public void SetLineWidth(float lineWidth)

Parameters

lineWidth float

SetScissor(uint, uint, Rect2D*)

public void SetScissor(uint firstScissor, uint scissorCount, Rect2D* scissors)

Parameters

firstScissor uint

scissorCount uint

scissors Rect2D*

SetStencilCompareMask(StencilFaceFlags, uint)

public void SetStencilCompareMask(StencilFaceFlags faceMask, uint compareMask)

Parameters

faceMask StencilFaceFlags

compareMask uint

SetStencilReference(StencilFaceFlags, uint)

public void SetStencilReference(StencilFaceFlags faceMask, uint reference)

Parameters

faceMask StencilFaceFlags

reference uint

SetStencilWriteMask(StencilFaceFlags, uint)

public void SetStencilWriteMask(StencilFaceFlags faceMask, uint writeMask)

Parameters

faceMask StencilFaceFlags

writeMask uint

SetViewport(uint, uint, Viewport*)

public void SetViewport(uint firstViewport, uint viewportCount, Viewport* viewports)

Parameters

firstViewport uint

viewportCount uint

viewports Viewport*

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

UpdateBuffer(Buffer, ulong, ulong, nint)

public void UpdateBuffer(Buffer destinationBuffer, ulong destinationOffset, ulong dataSize, nint data)

Parameters

destinationBuffer Buffer

destinationOffset ulong

dataSize ulong

data nint

WaitEvents(uint, Event, PipelineStageFlags, PipelineStageFlags, uint, MemoryBarrier*, uint, BufferMemoryBarrier*, uint, ImageMemoryBarrier*)

public void WaitEvents(uint eventCount, Event events, PipelineStageFlags sourceStageMask, PipelineStageFlags destinationStageMask, uint memoryBarrierCount, MemoryBarrier* memoryBarriers, uint bufferMemoryBarrierCount, BufferMemoryBarrier* bufferMemoryBarriers, uint imageMemoryBarrierCount, ImageMemoryBarrier* imageMemoryBarriers)

Parameters

eventCount uint

events Event

sourceStageMask PipelineStageFlags

destinationStageMask PipelineStageFlags

memoryBarrierCount uint

memoryBarriers MemoryBarrier*

bufferMemoryBarrierCount uint

bufferMemoryBarriers BufferMemoryBarrier*

imageMemoryBarrierCount uint

imageMemoryBarriers ImageMemoryBarrier*

WriteTimestamp(PipelineStageFlags, QueryPool, uint)

public void WriteTimestamp(PipelineStageFlags pipelineStage, QueryPool queryPool, uint query)

Parameters

pipelineStage PipelineStageFlags

queryPool QueryPool

query uint

Operators

operator ==(CommandBuffer, CommandBuffer)

public static bool operator ==(CommandBuffer left, CommandBuffer right)

Parameters

left CommandBuffer

right CommandBuffer

Returns

bool

operator !=(CommandBuffer, CommandBuffer)

public static bool operator !=(CommandBuffer left, CommandBuffer right)

Parameters

left CommandBuffer

right CommandBuffer

Returns

bool