kanzi::gfx::BaseCommand Class Reference

The base class for all graphics commands. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::BaseCommand:

Public Member Functions
uint32_t	getSize () const
	Gets the command size in bytes.
uint8_t	getTag () const
	Gets the command tag.
CommandType	getType () const
	Gets the command type.
void	setTag (uint8_t tag)
	Sets the command tag.

Protected Member Functions
	BaseCommand (CommandType t, uint32_t s)
	Constructor.
	BaseCommand (const BaseCommand &other)
	Copy Constructor.
BaseCommand &	operator= (const BaseCommand &other)
	Assignment operator.

Detailed Description

The base class for all graphics commands.

Since

Kanzi 4.0.0

Constructor & Destructor Documentation

BaseCommand() [1/2]

kanzi::gfx::BaseCommand::BaseCommand ( CommandType t, uint32_t s )

inlineprotected

Constructor.

Parameters

t	The command type.
s	The command size in bytes.

BaseCommand() [2/2]

kanzi::gfx::BaseCommand::BaseCommand ( const BaseCommand & other )

inlineprotected

Copy Constructor.

Parameters

other

The copy source.

Member Function Documentation

getType()

CommandType kanzi::gfx::BaseCommand::getType ( ) const

inline

Gets the command type.

Returns

The command type.

getSize()

uint32_t kanzi::gfx::BaseCommand::getSize ( ) const

inline

Gets the command size in bytes.

Returns

The command size in bytes.

getTag()

uint8_t kanzi::gfx::BaseCommand::getTag ( ) const

inline

Gets the command tag.

The upper 4 bits of this tag are reserved for internal use.

Returns

The command tag.

setTag()

void kanzi::gfx::BaseCommand::setTag ( uint8_t tag )

inline

Sets the command tag.

Used to attach metadata to the command. The upper 4 bits of this tag are reserved for internal use.

Parameters

tag	The command tag.

operator=()

BaseCommand & kanzi::gfx::BaseCommand::operator= ( const BaseCommand & other )

inlineprotected

Assignment operator.

Parameters

other

The assignment source.

---

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

• kanzi/gfx/commands.hpp