#include <Command.hpp>

Inheritance diagram for Foundation::RHI::RHICommandList:

Classes
struct	CopyBufferRegion

struct	CopyImageRegion

struct	GraphicsDesc

struct	PipelineDesc

struct	TransitionDesc

Public Member Functions
	RHICommandList (RHICommandPool const &commandPool)

virtual RHICommandList &	BeginTransition ()=0

virtual RHICommandList &	SetBufferTransition (RHIBuffer *buffer, TransitionDesc const &desc)=0

virtual RHICommandList &	SetImageTransition (RHITexture *image, TransitionDesc const &desc)=0

virtual RHICommandList &	EndTransition ()=0

virtual RHICommandList &	SetPipeline (PipelineDesc const &desc)=0

virtual RHICommandList &	BindDescriptorSet (RHIDevicePipelineType bindpoint, RHIPipelineState pipeline, Span< RHIDeviceDescriptorSet const > sets, size_t first=0)=0

virtual RHICommandList &	SetViewport (float x, float y, float width, float height, float depth_min=0.0, float depth_max=1.0)=0

virtual RHICommandList &	SetScissor (uint32_t x, uint32_t y, uint32_t width, uint32_t height)=0

virtual RHICommandList &	Draw (uint32_t vertex_count, uint32_t instance_count=1, uint32_t first_vertex=0, uint32_t first_instance=0)=0

virtual RHICommandList &	DrawIndexed (uint32_t index_count, uint32_t instance_count=1, uint32_t first_index=0, int32_t vertex_offset=0, uint32_t first_instance=0)=0

virtual RHICommandList &	DrawIndexedIndirectCount (RHIBuffer cmd_buffer, size_t cmd_offset, RHIBuffer count_buffer, size_t count_offset, uint32_t max_draw_count, uint32_t cmd_stride)=0

virtual RHICommandList &	DrawMeshTasks (uint32_t group_count_x, uint32_t group_count_y, uint32_t group_count_z)=0

virtual RHICommandList &	DrawMeshTasksIndirect (RHIBuffer *cmd_buffer, size_t cmd_offset, size_t draw_count, size_t stride)=0

virtual RHICommandList &	PushConstant (RHIPipelineState *pipeline, RHIShaderStage stage, uint32_t offset, Span< const char > data)=0

virtual RHICommandList &	FillBuffer (RHIBuffer *buffer, uint32_t value, size_t offset=0, size_t size=kFullSize)=0

virtual RHICommandList &	CopyBuffer (RHIBuffer src_buffer, RHIBuffer dst_buffer, Span< const CopyBufferRegion > regions)=0

virtual RHICommandList &	CopyImage (RHITexture src_image, RHITextureLayout src_layout, RHITexture dst_image, RHITextureLayout dst_layout, Span< const CopyImageRegion > regions)=0

virtual RHICommandList &	CopyBufferToImage (RHIBuffer src_buffer, RHITexture dst_image, RHITextureLayout dst_layout, Span< const CopyImageRegion > regions)=0

virtual RHICommandList &	BeginGraphics (GraphicsDesc const &desc)=0

virtual RHICommandList &	BindVertexBuffer (uint32_t index, Span< RHIBuffer *const > buffers, Span< const size_t > offsets)=0

virtual RHICommandList &	BindIndexBuffer (RHIBuffer *buffer, size_t offset=0, RHIResourceFormat format=RHIResourceFormat::R32Uint)=0

virtual RHICommandList &	EndGraphics ()=0

virtual RHICommandList &	Dispatch (uint32_t group_count_x, uint32_t group_count_y, uint32_t group_count_z)=0

virtual RHICommandList &	DebugBegin (const char *message)=0

virtual RHICommandList &	DebugInsertMarker (const char *message)=0

virtual RHICommandList &	DebugEnd ()=0

virtual RHICommandList &	Begin ()=0

virtual void	End ()=0

virtual void	Reset ()=0

virtual void	DebugSetObjectName (const char *name)=0

Public Member Functions inherited from Foundation::RHI::RHIObject
	RHIObject ()=default

	RHIObject (RHIObject const &)=delete

RHIObject &	operator= (const RHIObject &)=delete

	RHIObject (RHIObject &&)=delete

RHIObject &	operator= (RHIObject &&)=delete

virtual	~RHIObject ()=default

Protected Attributes
const RHICommandPool &	mCommandPool

Constructor & Destructor Documentation

◆ RHICommandList()

Foundation::RHI::RHICommandList::RHICommandList ( RHICommandPool const & commandPool )

inline

Member Function Documentation

◆ Begin()

virtual RHICommandList & Foundation::RHI::RHICommandList::Begin ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ BeginGraphics()

virtual RHICommandList & Foundation::RHI::RHICommandList::BeginGraphics ( GraphicsDesc const & desc )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ BeginTransition()

virtual RHICommandList & Foundation::RHI::RHICommandList::BeginTransition ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ BindDescriptorSet()

virtual RHICommandList & Foundation::RHI::RHICommandList::BindDescriptorSet	(	RHIDevicePipelineType	bindpoint,
		RHIPipelineState *	pipeline,
		Span< RHIDeviceDescriptorSet *const >	sets,
		size_t	first = `0`
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ BindIndexBuffer()

virtual RHICommandList & Foundation::RHI::RHICommandList::BindIndexBuffer	(	RHIBuffer *	buffer,
		size_t	offset = `0`,
		RHIResourceFormat	format = `RHIResourceFormat::R32Uint`
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ BindVertexBuffer()

virtual RHICommandList & Foundation::RHI::RHICommandList::BindVertexBuffer	(	uint32_t	index,
		Span< RHIBuffer *const >	buffers,
		Span< const size_t >	offsets
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ CopyBuffer()

virtual RHICommandList & Foundation::RHI::RHICommandList::CopyBuffer	(	RHIBuffer *	src_buffer,
		RHIBuffer *	dst_buffer,
		Span< const CopyBufferRegion >	regions
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ CopyBufferToImage()

virtual RHICommandList & Foundation::RHI::RHICommandList::CopyBufferToImage	(	RHIBuffer *	src_buffer,
		RHITexture *	dst_image,
		RHITextureLayout	dst_layout,
		Span< const CopyImageRegion >	regions
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ CopyImage()

virtual RHICommandList & Foundation::RHI::RHICommandList::CopyImage	(	RHITexture *	src_image,
		RHITextureLayout	src_layout,
		RHITexture *	dst_image,
		RHITextureLayout	dst_layout,
		Span< const CopyImageRegion >	regions
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DebugBegin()

virtual RHICommandList & Foundation::RHI::RHICommandList::DebugBegin ( const char * message )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DebugEnd()

virtual RHICommandList & Foundation::RHI::RHICommandList::DebugEnd ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DebugInsertMarker()

virtual RHICommandList & Foundation::RHI::RHICommandList::DebugInsertMarker ( const char * message )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DebugSetObjectName()

virtual void Foundation::RHI::RHICommandList::DebugSetObjectName ( const char * name )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ Dispatch()

virtual RHICommandList & Foundation::RHI::RHICommandList::Dispatch	(	uint32_t	group_count_x,
		uint32_t	group_count_y,
		uint32_t	group_count_z
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ Draw()

virtual RHICommandList & Foundation::RHI::RHICommandList::Draw	(	uint32_t	vertex_count,
		uint32_t	instance_count = `1`,
		uint32_t	first_vertex = `0`,
		uint32_t	first_instance = `0`
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DrawIndexed()

virtual RHICommandList & Foundation::RHI::RHICommandList::DrawIndexed	(	uint32_t	index_count,
		uint32_t	instance_count = `1`,
		uint32_t	first_index = `0`,
		int32_t	vertex_offset = `0`,
		uint32_t	first_instance = `0`
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DrawIndexedIndirectCount()

virtual RHICommandList & Foundation::RHI::RHICommandList::DrawIndexedIndirectCount	(	RHIBuffer *	cmd_buffer,
		size_t	cmd_offset,
		RHIBuffer *	count_buffer,
		size_t	count_offset,
		uint32_t	max_draw_count,
		uint32_t	cmd_stride
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DrawMeshTasks()

virtual RHICommandList & Foundation::RHI::RHICommandList::DrawMeshTasks	(	uint32_t	group_count_x,
		uint32_t	group_count_y,
		uint32_t	group_count_z
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ DrawMeshTasksIndirect()

virtual RHICommandList & Foundation::RHI::RHICommandList::DrawMeshTasksIndirect	(	RHIBuffer *	cmd_buffer,
		size_t	cmd_offset,
		size_t	draw_count,
		size_t	stride
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ End()

virtual void Foundation::RHI::RHICommandList::End ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ EndGraphics()

virtual RHICommandList & Foundation::RHI::RHICommandList::EndGraphics ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ EndTransition()

virtual RHICommandList & Foundation::RHI::RHICommandList::EndTransition ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ FillBuffer()

virtual RHICommandList & Foundation::RHI::RHICommandList::FillBuffer	(	RHIBuffer *	buffer,
		uint32_t	value,
		size_t	offset = `0`,
		size_t	size = `kFullSize`
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ PushConstant()

virtual RHICommandList & Foundation::RHI::RHICommandList::PushConstant	(	RHIPipelineState *	pipeline,
		RHIShaderStage	stage,
		uint32_t	offset,
		Span< const char >	data
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ Reset()

virtual void Foundation::RHI::RHICommandList::Reset ( )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ SetBufferTransition()

virtual RHICommandList & Foundation::RHI::RHICommandList::SetBufferTransition	(	RHIBuffer *	buffer,
		TransitionDesc const &	desc
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ SetImageTransition()

virtual RHICommandList & Foundation::RHI::RHICommandList::SetImageTransition	(	RHITexture *	image,
		TransitionDesc const &	desc
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ SetPipeline()

virtual RHICommandList & Foundation::RHI::RHICommandList::SetPipeline ( PipelineDesc const & desc )

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ SetScissor()

virtual RHICommandList & Foundation::RHI::RHICommandList::SetScissor	(	uint32_t	x,
		uint32_t	y,
		uint32_t	width,
		uint32_t	height
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

◆ SetViewport()

virtual RHICommandList & Foundation::RHI::RHICommandList::SetViewport	(	float	x,
		float	y,
		float	width,
		float	height,
		float	depth_min = `0.0`,
		float	depth_max = `1.0`
	)

pure virtual

Implemented in Foundation::RHI::VulkanCommandList.

Member Data Documentation

◆ mCommandPool

const RHICommandPool& Foundation::RHI::RHICommandList::mCommandPool

protected

The documentation for this class was generated from the following file:

Source/RHICore/Command.hpp

Classes

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ RHICommandList()

Member Function Documentation

◆ Begin()

◆ BeginGraphics()

◆ BeginTransition()

◆ BindDescriptorSet()

◆ BindIndexBuffer()

◆ BindVertexBuffer()

◆ CopyBuffer()

◆ CopyBufferToImage()

◆ CopyImage()

◆ DebugBegin()

◆ DebugEnd()

◆ DebugInsertMarker()

◆ DebugSetObjectName()

◆ Dispatch()

◆ Draw()

◆ DrawIndexed()

◆ DrawIndexedIndirectCount()

◆ DrawMeshTasks()

◆ DrawMeshTasksIndirect()

◆ End()

◆ EndGraphics()

◆ EndTransition()

◆ FillBuffer()

◆ PushConstant()

◆ Reset()

◆ SetBufferTransition()

◆ SetImageTransition()

◆ SetPipeline()

◆ SetScissor()

◆ SetViewport()

Member Data Documentation

◆ mCommandPool