Class VFakeCommandBuffer

java.lang.Object

com.io7m.jcoronado.fake.VFakeCommandBuffer

All Implemented Interfaces:

VulkanCommandBufferType, VulkanHandleDispatchableType, VulkanHandleType, com.io7m.jmulticlose.core.CloseableType, AutoCloseable

public final class VFakeCommandBuffer
extends Object
implements VulkanCommandBufferType

A fake command buffer.

Method Summary

Modifier and Type	Method	Description
void	beginCommandBuffer(VulkanCommandBufferBeginInfo info)	Begin a command buffer.
void	beginQuery(VulkanQueryPoolType pool, int query, Set<VulkanQueryControlFlag> flags)	Begin a query.
void	beginRendering(VulkanRenderingInfo renderingInfo)	Begin dynamic rendering.
void	beginRenderPass(VulkanRenderPassBeginInfo info, VulkanSubpassContents contents)	Specify how commands in the first subpass of a render pass are provided.
void	bindDescriptorSets(VulkanPipelineBindPoint pipeline_bind_point, VulkanPipelineLayoutType layout, int first_set, List<VulkanDescriptorSetType> descriptor_sets, List<Integer> dynamic_offsets)	Bind descriptor sets to a command buffer.
void	bindIndexBuffer(VulkanBufferType buffer, long offset, VulkanIndexType index_type)	Bind index buffer to a command buffer.
void	bindPipeline(VulkanPipelineBindPoint bind_point, VulkanPipelineType pipeline)	Bind a rendering pipeline.
void	bindVertexBuffers(int first_binding, int binding_count, List<VulkanBufferType> buffers, List<Long> offsets)	Bind vertex buffers to a command buffer.
void	blitImage(VulkanImageType source_image, VulkanImageLayout source_image_layout, VulkanImageType target_image, VulkanImageLayout target_image_layout, List<VulkanImageBlit> regions, VulkanFilter filter)	Copy regions of an image, potentially performing format conversion.
void	clearAttachments(List<VulkanClearAttachment> attachments, List<VulkanClearRectangle> rectangles)	Clear regions within bound framebuffer attachments.
void	clearColorImage(VulkanImageType image, VulkanImageLayout image_layout, VulkanClearValueType.VulkanClearValueColorType color, List<VulkanImageSubresourceRange> ranges)	Clear regions of a color image.
void	clearDepthStencilImage(VulkanImageType image, VulkanImageLayout image_layout, VulkanClearValueDepthStencil depth_stencil, List<VulkanImageSubresourceRange> ranges)	Clear regions of a depth stencil image.
void	close()	Destroy the object.
void	copyBuffer(VulkanBufferType source, VulkanBufferType target, List<VulkanBufferCopy> regions)	Copy data between buffer regions.
void	copyBufferToImage(VulkanBufferType source_buffer, VulkanImageType target_image, VulkanImageLayout target_image_layout, List<VulkanBufferImageCopy> regions)	Copy data from a buffer to an image.
void	copyImage(VulkanImageType source_image, VulkanImageLayout source_image_layout, VulkanImageType target_image, VulkanImageLayout target_image_layout, List<VulkanImageCopy> regions)	Copy regions of an image, potentially performing format conversion.
void	copyImageToBuffer(VulkanImageType source_image, VulkanImageLayout source_layout, VulkanBufferType target_buffer, List<VulkanBufferImageCopy> regions)	Copy data from an image to a buffer.
void	dispatch(int group_count_x, int group_count_y, int group_count_z)	Dispatch compute work items.
void	draw(int vertex_count, int instance_count, int first_vertex, int first_instance)	Draw primitives.
void	drawIndexed(int vertex_count, int instance_count, int first_vertex, int vertex_offset, int first_instance)	Draw primitives using an index buffer.
void	drawIndexedIndirect(VulkanBufferType buffer, long offset, int draw_count, int stride)	Draw primitives indirectly.
void	drawIndirect(VulkanBufferType buffer, long offset, int draw_count, int stride)	Draw primitives indirectly.
void	endCommandBuffer()	End a command buffer.
void	endQuery(VulkanQueryPoolType pool, int query)	End a query.
void	endRendering()	End dynamic rendering.
void	endRenderPass()	End a render pass.
void	executeCommands(List<VulkanCommandBufferType> commandBuffers)	Execute a secondary command buffer from a primary command buffer.
void	fillBuffer(VulkanBufferType buffer, long offset, long size, int data)	Fill a region of a buffer with a fixed value.
boolean	isClosed()
void	nextSubpass(VulkanSubpassContents contents)	Transition to the next subpass of a render pass.
void	pipelineBarrier(VulkanDependencyInfo info)	Insert a memory dependency.
void	pushConstants(VulkanPipelineLayoutType layout, Set<VulkanShaderStageFlag> stageFlags, long offset, ByteBuffer data)	Update the values of push constants.
void	reset(Set<VulkanCommandBufferResetFlag> flags)	Reset a command buffer to the initial state.
void	resetEvent(VulkanEventType event, Set<VulkanPipelineStageFlag> mask)	Reset an event object to non-signaled state.
void	resetQueryPool(VulkanQueryPoolType pool, int first_query, int query_count)	Reset a query pool.
void	setBlendConstants(VulkanBlendConstants constants)	Set the values of blend constants.
void	setDepthBias(float depth_bias_constant_factor, float depth_bias_clamp, float depth_bias_slope_factor)	Set the depth bias dynamic state.
void	setDepthBounds(float min_depth_bounds, float max_depth_bounds)	Set the depth bounds test values for a command buffer.
void	setEvent(VulkanEventType event, VulkanDependencyInfo info)	Set an event object to signaled state.
void	setLineWidth(float width)	Set the dynamic line width state.
void	setScissor(int first_scissor, List<VulkanRectangle2D> rectangles)	Set the dynamic scissor rectangles on a command buffer.
void	setStencilCompareMask(Set<VulkanStencilFaceFlag> face_mask, int mask)	Set the stencil compare mask.
void	setStencilReference(Set<VulkanStencilFaceFlag> face_mask, int reference)	Set the stencil reference.
void	setStencilWriteMask(Set<VulkanStencilFaceFlag> face_mask, int mask)	Set the stencil write mask.
void	setViewport(int first_viewport, List<VulkanViewport> viewports)	Set the viewport on a command buffer.
void	waitEvents(List<VulkanEventType> events, List<VulkanDependencyInfo> dependencyInfos)	Wait for one or more events and insert a set of memory barriers.
void	writeTimestamp(VulkanPipelineStageFlag stage, VulkanQueryPoolType pool, int query_index)	Write a device timestamp into a query object.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface VulkanCommandBufferType

beginCommandBuffer, beginCommandBuffer, blitImage, clearAttachments, clearAttachments, clearAttachments, copyImage

Method Details

beginCommandBuffer

public void beginCommandBuffer(VulkanCommandBufferBeginInfo info)

Description copied from interface: VulkanCommandBufferType

Begin a command buffer.

Specified by:

beginCommandBuffer in interface VulkanCommandBufferType

Parameters:

info - The begin info

beginQuery

public void beginQuery(VulkanQueryPoolType pool,
 int query,
 Set<VulkanQueryControlFlag> flags)

Description copied from interface: VulkanCommandBufferType

Begin a query.

Specified by:

beginQuery in interface VulkanCommandBufferType

Parameters:

pool - The query pool

query - The query index

flags - Control flags for the query

endQuery

public void endQuery(VulkanQueryPoolType pool,
 int query)

Description copied from interface: VulkanCommandBufferType

End a query.

Specified by:

endQuery in interface VulkanCommandBufferType

Parameters:

pool - The query pool

query - The query index

beginRenderPass

public void beginRenderPass(VulkanRenderPassBeginInfo info,
 VulkanSubpassContents contents)

Description copied from interface: VulkanCommandBufferType

Specify how commands in the first subpass of a render pass are provided.

Specified by:

beginRenderPass in interface VulkanCommandBufferType

Parameters:

info - The begin info

contents - Specifies how the commands in the first subpass will be provided.

bindPipeline

public void bindPipeline(VulkanPipelineBindPoint bind_point,
 VulkanPipelineType pipeline)

Description copied from interface: VulkanCommandBufferType

Bind a rendering pipeline.

Specified by:

bindPipeline in interface VulkanCommandBufferType

Parameters:

bind_point - The bind point

pipeline - The pipeline

bindVertexBuffers

public void bindVertexBuffers(int first_binding,
 int binding_count,
 List<VulkanBufferType> buffers,
 List<Long> offsets)

Description copied from interface: VulkanCommandBufferType

Bind vertex buffers to a command buffer.

Specified by:

bindVertexBuffers in interface VulkanCommandBufferType

Parameters:

first_binding - The index of the first vertex input binding whose state is updated by the command

binding_count - The number of vertex input bindings whose state is updated by the command

buffers - An array of buffer handles

offsets - An array of buffer offsets

bindIndexBuffer

public void bindIndexBuffer(VulkanBufferType buffer,
 long offset,
 VulkanIndexType index_type)

Description copied from interface: VulkanCommandBufferType

Bind index buffer to a command buffer.

Specified by:

bindIndexBuffer in interface VulkanCommandBufferType

Parameters:

buffer - The index buffer

offset - The starting offset in bytes within buffer used in index buffer address calculations

index_type - The type of indices

bindDescriptorSets

public void bindDescriptorSets(VulkanPipelineBindPoint pipeline_bind_point,
 VulkanPipelineLayoutType layout,
 int first_set,
 List<VulkanDescriptorSetType> descriptor_sets,
 List<Integer> dynamic_offsets)

Description copied from interface: VulkanCommandBufferType

Bind descriptor sets to a command buffer.

Specified by:

bindDescriptorSets in interface VulkanCommandBufferType

Parameters:

pipeline_bind_point - The pipeline bind point

layout - The pipeline layout

first_set - The set number of the first descriptor set to be bound

descriptor_sets - The descriptor sets

dynamic_offsets - An array of dynamic offsets

blitImage

public void blitImage(VulkanImageType source_image,
 VulkanImageLayout source_image_layout,
 VulkanImageType target_image,
 VulkanImageLayout target_image_layout,
 List<VulkanImageBlit> regions,
 VulkanFilter filter)

Description copied from interface: VulkanCommandBufferType

Copy regions of an image, potentially performing format conversion.

Specified by:

blitImage in interface VulkanCommandBufferType

Parameters:

source_image - The source image

source_image_layout - The layout of the source image

target_image - The target image

target_image_layout - The target image layout

regions - The regions that will be used to blit

filter - The filter to apply if the blits require scaling

copyBuffer

public void copyBuffer(VulkanBufferType source,
 VulkanBufferType target,
 List<VulkanBufferCopy> regions)

Description copied from interface: VulkanCommandBufferType

Copy data between buffer regions.

Specified by:

copyBuffer in interface VulkanCommandBufferType

Parameters:

source - The source buffer

target - The target buffer

regions - The list of regions to be copied

copyImageToBuffer

public void copyImageToBuffer(VulkanImageType source_image,
 VulkanImageLayout source_layout,
 VulkanBufferType target_buffer,
 List<VulkanBufferImageCopy> regions)

Description copied from interface: VulkanCommandBufferType

Copy data from an image to a buffer.

Specified by:

copyImageToBuffer in interface VulkanCommandBufferType

Parameters:

source_image - The source image

source_layout - The source layout

target_buffer - The target buffer

regions - The list of regions to be copied

copyBufferToImage

public void copyBufferToImage(VulkanBufferType source_buffer,
 VulkanImageType target_image,
 VulkanImageLayout target_image_layout,
 List<VulkanBufferImageCopy> regions)

Description copied from interface: VulkanCommandBufferType

Copy data from a buffer to an image.

Specified by:

copyBufferToImage in interface VulkanCommandBufferType

Parameters:

source_buffer - The source buffer

target_image - The target image

target_image_layout - The target image layout

regions - The list of regions to be copied

copyImage

public void copyImage(VulkanImageType source_image,
 VulkanImageLayout source_image_layout,
 VulkanImageType target_image,
 VulkanImageLayout target_image_layout,
 List<VulkanImageCopy> regions)

Description copied from interface: VulkanCommandBufferType

Copy regions of an image, potentially performing format conversion.

Specified by:

copyImage in interface VulkanCommandBufferType

Parameters:

source_image - The source image

source_image_layout - The layout of the source image

target_image - The target image

target_image_layout - The target image layout

regions - The regions that will be used to copy

clearAttachments

public void clearAttachments(List<VulkanClearAttachment> attachments,
 List<VulkanClearRectangle> rectangles)

Description copied from interface: VulkanCommandBufferType

Clear regions within bound framebuffer attachments.

Specified by:

clearAttachments in interface VulkanCommandBufferType

Parameters:

attachments - The attachments to clear and the clear values to use

rectangles - An array of structures defining regions within each selected attachment to clear

clearColorImage

public void clearColorImage(VulkanImageType image,
 VulkanImageLayout image_layout,
 VulkanClearValueType.VulkanClearValueColorType color,
 List<VulkanImageSubresourceRange> ranges)

Description copied from interface: VulkanCommandBufferType

Clear regions of a color image.

Specified by:

clearColorImage in interface VulkanCommandBufferType

Parameters:

image - The image

image_layout - The image layout

color - The color value

ranges - The image subresource ranges

clearDepthStencilImage

public void clearDepthStencilImage(VulkanImageType image,
 VulkanImageLayout image_layout,
 VulkanClearValueDepthStencil depth_stencil,
 List<VulkanImageSubresourceRange> ranges)

Description copied from interface: VulkanCommandBufferType

Clear regions of a depth stencil image.

Specified by:

clearDepthStencilImage in interface VulkanCommandBufferType

Parameters:

image - The image

image_layout - The image layout

depth_stencil - The depth stencil value

ranges - The image subresource ranges

dispatch

public void dispatch(int group_count_x,
 int group_count_y,
 int group_count_z)

Description copied from interface: VulkanCommandBufferType

Dispatch compute work items.

Specified by:

dispatch in interface VulkanCommandBufferType

Parameters:

group_count_x - The number of local workgroups to dispatch in the X dimension.

group_count_y - The number of local workgroups to dispatch in the Y dimension.

group_count_z - The number of local workgroups to dispatch in the Z dimension.

draw

public void draw(int vertex_count,
 int instance_count,
 int first_vertex,
 int first_instance)

Description copied from interface: VulkanCommandBufferType

Draw primitives.

Specified by:

draw in interface VulkanCommandBufferType

Parameters:

vertex_count - The number of vertices to draw.

instance_count - The number of instances to draw.

first_vertex - The index of the first vertex to draw.

first_instance - The instance ID of the first instance to draw.

drawIndexed

public void drawIndexed(int vertex_count,
 int instance_count,
 int first_vertex,
 int vertex_offset,
 int first_instance)

Description copied from interface: VulkanCommandBufferType

Draw primitives using an index buffer.

Specified by:

drawIndexed in interface VulkanCommandBufferType

Parameters:

vertex_count - The number of vertices to draw.

instance_count - The number of instances to draw.

first_vertex - The index of the first vertex to draw.

vertex_offset - The value added to the vertex index before indexing into the vertex buffer.

first_instance - The instance ID of the first instance to draw.

drawIndirect

public void drawIndirect(VulkanBufferType buffer,
 long offset,
 int draw_count,
 int stride)

Description copied from interface: VulkanCommandBufferType

Draw primitives indirectly.

Specified by:

drawIndirect in interface VulkanCommandBufferType

Parameters:

buffer - The buffer containing draw parameters.

offset - The byte offset into buffer where parameters begin.

draw_count - The number of draws to execute, and can be zero.

stride - The byte stride between successive sets of draw parameters.

drawIndexedIndirect

public void drawIndexedIndirect(VulkanBufferType buffer,
 long offset,
 int draw_count,
 int stride)

Description copied from interface: VulkanCommandBufferType

Draw primitives indirectly.

Specified by:

drawIndexedIndirect in interface VulkanCommandBufferType

Parameters:

buffer - The buffer containing draw parameters.

offset - The byte offset into buffer where parameters begin.

draw_count - The number of draws to execute, and can be zero.

stride - The byte stride between successive sets of draw parameters.

executeCommands

public void executeCommands(List<VulkanCommandBufferType> commandBuffers)

Description copied from interface: VulkanCommandBufferType

Execute a secondary command buffer from a primary command buffer.

Specified by:

executeCommands in interface VulkanCommandBufferType

Parameters:

commandBuffers - The buffers to be executed

fillBuffer

public void fillBuffer(VulkanBufferType buffer,
 long offset,
 long size,
 int data)

Description copied from interface: VulkanCommandBufferType

Fill a region of a buffer with a fixed value.

Specified by:

fillBuffer in interface VulkanCommandBufferType

Parameters:

buffer - The buffer to be filled.

offset - The byte offset into the buffer at which to start filling, and must be a multiple of 4.

size - The number of bytes to fill, and must be either a multiple of 4, or VK_WHOLE_SIZE to fill the range from offset to the end of the buffer. If VK_WHOLE_SIZE is used and the remaining size of the buffer is not a multiple of 4, then the nearest smaller multiple is used.

data - The 4-byte word written repeatedly to the buffer to fill size bytes of data. The data word is written to memory according to the host endianness.

endRenderPass

public void endRenderPass()

Description copied from interface: VulkanCommandBufferType

End a render pass.

Specified by:

endRenderPass in interface VulkanCommandBufferType

pipelineBarrier

public void pipelineBarrier(VulkanDependencyInfo info)

Description copied from interface: VulkanCommandBufferType

Insert a memory dependency.

Specified by:

pipelineBarrier in interface VulkanCommandBufferType

Parameters:

info - The dependency info

nextSubpass

public void nextSubpass(VulkanSubpassContents contents)

Description copied from interface: VulkanCommandBufferType

Transition to the next subpass of a render pass.

Specified by:

nextSubpass in interface VulkanCommandBufferType

Parameters:

contents - Specifies how the commands in the next subpass will be provided, in the same fashion as the corresponding parameter of vkCmdBeginRenderPass.

setLineWidth

public void setLineWidth(float width)

Description copied from interface: VulkanCommandBufferType

Set the dynamic line width state.

Specified by:

setLineWidth in interface VulkanCommandBufferType

Parameters:

width - The width of rasterized line segments.

setDepthBias

public void setDepthBias(float depth_bias_constant_factor,
 float depth_bias_clamp,
 float depth_bias_slope_factor)

Description copied from interface: VulkanCommandBufferType

Set the depth bias dynamic state.

Specified by:

setDepthBias in interface VulkanCommandBufferType

Parameters:

depth_bias_constant_factor - A scalar factor controlling the constant depth value added to each fragment.

depth_bias_clamp - The maximum (or minimum) depth bias of a fragment.

depth_bias_slope_factor - A scalar factor applied to a fragment’s slope in depth bias calculations.

setDepthBounds

public void setDepthBounds(float min_depth_bounds,
 float max_depth_bounds)

Description copied from interface: VulkanCommandBufferType

Set the depth bounds test values for a command buffer.

Specified by:

setDepthBounds in interface VulkanCommandBufferType

Parameters:

min_depth_bounds - The lower bound of the range of depth values used in the depth bounds test.

max_depth_bounds - The upper bound of the range of depth values used in the depth bounds test.

setBlendConstants

public void setBlendConstants(VulkanBlendConstants constants)

Description copied from interface: VulkanCommandBufferType

Set the values of blend constants.

Specified by:

setBlendConstants in interface VulkanCommandBufferType

Parameters:

constants - The R, G, B, and A components of the blend constant color used in blending, depending on the blend factor.

setStencilReference

public void setStencilReference(Set<VulkanStencilFaceFlag> face_mask,
 int reference)

Description copied from interface: VulkanCommandBufferType

Set the stencil reference.

Specified by:

setStencilReference in interface VulkanCommandBufferType

Parameters:

face_mask - A set of flags specifying the set of stencil state for which to update the reference value.

reference - The new value to use as the stencil reference value.

setStencilCompareMask

public void setStencilCompareMask(Set<VulkanStencilFaceFlag> face_mask,
 int mask)

Description copied from interface: VulkanCommandBufferType

Set the stencil compare mask.

Specified by:

setStencilCompareMask in interface VulkanCommandBufferType

Parameters:

face_mask - A set of flags specifying the set of stencil state for which to update the reference value.

mask - The new value to use as the stencil compare mask value.

setStencilWriteMask

public void setStencilWriteMask(Set<VulkanStencilFaceFlag> face_mask,
 int mask)

Description copied from interface: VulkanCommandBufferType

Set the stencil write mask.

Specified by:

setStencilWriteMask in interface VulkanCommandBufferType

Parameters:

face_mask - A set of flags specifying the set of stencil state for which to update the reference value.

mask - The new value to use as the stencil write mask value.

setScissor

public void setScissor(int first_scissor,
 List<VulkanRectangle2D> rectangles)

Description copied from interface: VulkanCommandBufferType

Set the dynamic scissor rectangles on a command buffer.

Specified by:

setScissor in interface VulkanCommandBufferType

Parameters:

first_scissor - The index of the first scissor whose state is updated by the command.

rectangles - An array of structures defining scissor rectangles.

setViewport

public void setViewport(int first_viewport,
 List<VulkanViewport> viewports)

Description copied from interface: VulkanCommandBufferType

Set the viewport on a command buffer.

Specified by:

setViewport in interface VulkanCommandBufferType

Parameters:

first_viewport - The index of the first viewport whose state is updated by the command.

viewports - An array of structures defining viewport rectangles.

setEvent

public void setEvent(VulkanEventType event,
 VulkanDependencyInfo info)

Description copied from interface: VulkanCommandBufferType

Set an event object to signaled state.

Specified by:

setEvent in interface VulkanCommandBufferType

Parameters:

event - The event

info - The dependency info.

resetEvent

public void resetEvent(VulkanEventType event,
 Set<VulkanPipelineStageFlag> mask)

Description copied from interface: VulkanCommandBufferType

Reset an event object to non-signaled state.

Specified by:

resetEvent in interface VulkanCommandBufferType

Parameters:

event - The event

mask - The source stage mask used to determine when the event is signaled.

resetQueryPool

public void resetQueryPool(VulkanQueryPoolType pool,
 int first_query,
 int query_count)

Description copied from interface: VulkanCommandBufferType

Reset a query pool.

Specified by:

resetQueryPool in interface VulkanCommandBufferType

Parameters:

pool - The query pool

first_query - The initial query index to reset

query_count - The number of queries to reset

endCommandBuffer

public void endCommandBuffer()

Description copied from interface: VulkanCommandBufferType

End a command buffer.

Specified by:

endCommandBuffer in interface VulkanCommandBufferType

writeTimestamp

public void writeTimestamp(VulkanPipelineStageFlag stage,
 VulkanQueryPoolType pool,
 int query_index)

Description copied from interface: VulkanCommandBufferType

Write a device timestamp into a query object.

Specified by:

writeTimestamp in interface VulkanCommandBufferType

Parameters:

stage - The stage of the pipeline

pool - The query pool

query_index - The query index

waitEvents

public void waitEvents(List<VulkanEventType> events,
 List<VulkanDependencyInfo> dependencyInfos)

Description copied from interface: VulkanCommandBufferType

Wait for one or more events and insert a set of memory barriers.

Specified by:

waitEvents in interface VulkanCommandBufferType

Parameters:

events - The events upon which to wait

dependencyInfos - The dependency info

reset

public void reset(Set<VulkanCommandBufferResetFlag> flags)

Description copied from interface: VulkanCommandBufferType

Reset a command buffer to the initial state.

Specified by:

reset in interface VulkanCommandBufferType

Parameters:

flags - The flags

beginRendering

public void beginRendering(VulkanRenderingInfo renderingInfo)

Description copied from interface: VulkanCommandBufferType

Begin dynamic rendering.

Specified by:

beginRendering in interface VulkanCommandBufferType

Parameters:

renderingInfo - The rendering info

endRendering

public void endRendering()

Description copied from interface: VulkanCommandBufferType

End dynamic rendering.

Specified by:

endRendering in interface VulkanCommandBufferType

pushConstants

public void pushConstants(VulkanPipelineLayoutType layout,
 Set<VulkanShaderStageFlag> stageFlags,
 long offset,
 ByteBuffer data)

Description copied from interface: VulkanCommandBufferType

Update the values of push constants.

Specified by:

pushConstants in interface VulkanCommandBufferType

Parameters:

layout - The pipeline layout

stageFlags - The stage flags

offset - The offset

data - The data

close

public void close()

Description copied from interface: VulkanHandleType

Destroy the object.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VulkanHandleType

isClosed

public boolean isClosed()

Specified by:

isClosed in interface com.io7m.jmulticlose.core.CloseableType