talvos::DispatchCommand Class Reference

This class encapsulates information about a compute kernel launch. More...

#include <talvos/Commands.h>

Inheritance diagram for talvos::DispatchCommand:

Public Member Functions
	DispatchCommand (const PipelineContext &PC, Dim3 BaseGroup, Dim3 NumGroups)
	Create a new DispatchCommand. More...
Dim3	getBaseGroup () const
	Returns the base workgroup offset used by this command. More...
Dim3	getNumGroups () const
	Returns the number of workgroups this command launches. More...
const PipelineContext &	getPipelineContext () const
	Returns the pipeline context. More...
Public Member Functions inherited from talvos::Command
Type	getType () const
	Returns the type of this command. More...
void	run (Device &Dev) const
	Run this command on Dev. More...

Protected Member Functions
virtual void	runImpl (Device &Dev) const override
	Command execution handler. More...
Protected Member Functions inherited from talvos::Command
	Command (Type Ty)
	Used by subclasses to initialize the command type. More...

Private Attributes
PipelineContext	PC
	The pipeline context. More...
Dim3	BaseGroup
	The base workgroup offset. More...
Dim3	NumGroups
	The number of workgroups to launch. More...

Additional Inherited Members
Public Types inherited from talvos::Command
enum	Type {   BEGIN_RENDER_PASS, BLIT_IMAGE, CLEAR_ATTACHMENT, CLEAR_COLOR_IMAGE,   COPY_BUFFER, COPY_BUFFER_TO_IMAGE, COPY_IMAGE, COPY_IMAGE_TO_BUFFER,   DISPATCH, DRAW, DRAW_INDEXED, END_RENDER_PASS,   FILL_BUFFER, NEXT_SUBPASS, SET_EVENT, RESET_EVENT,   UPDATE_BUFFER, WAIT_EVENTS }
	Identifies different Command subclasses. More...
Protected Attributes inherited from talvos::Command
Type	Ty
	The type of this command. More...

Detailed Description

This class encapsulates information about a compute kernel launch.

Definition at line 278 of file Commands.h.

Constructor & Destructor Documentation

talvos::DispatchCommand::DispatchCommand ( const PipelineContext &  PC, Dim3  BaseGroup, Dim3  NumGroups  )

inline

Create a new DispatchCommand.

Parameters

PC	The pipeline context used for the shader launch.
BaseGroup	The base workgroup offset.
NumGroups	The number of groups to launch.

Definition at line 286 of file Commands.h.

Member Function Documentation

Dim3 talvos::DispatchCommand::getBaseGroup ( ) const

inline

Returns the base workgroup offset used by this command.

Definition at line 291 of file Commands.h.

Dim3 talvos::DispatchCommand::getNumGroups ( ) const

inline

Returns the number of workgroups this command launches.

Definition at line 294 of file Commands.h.

const PipelineContext& talvos::DispatchCommand::getPipelineContext ( ) const

inline

Returns the pipeline context.

Definition at line 297 of file Commands.h.

void talvos::DispatchCommand::runImpl ( Device &  Dev ) const

overrideprotectedvirtual

Command execution handler.

Implements talvos::Command.

Definition at line 339 of file Commands.cpp.

Member Data Documentation

Dim3 talvos::DispatchCommand::BaseGroup

private

The base workgroup offset.

Definition at line 306 of file Commands.h.

Dim3 talvos::DispatchCommand::NumGroups

private

The number of workgroups to launch.

Definition at line 307 of file Commands.h.

PipelineContext talvos::DispatchCommand::PC

private

The pipeline context.

Definition at line 304 of file Commands.h.