QColorMask Class

class Qt3DRender::QColorMask

Allows specifying which color components should be written to the currently bound frame buffer. More...

Header:	#include <QColorMask>
CMake:	find_package(Qt6 REQUIRED COMPONENTS 3drender) target_link_libraries(mytarget PRIVATE Qt6::3drender)
qmake:	QT += 3drender
Since:	Qt 5.7
Instantiated By:	ColorMask
Inherits:	Qt3DRender::QRenderState

List of all members, including inherited members

Properties

alphaMasked : bool
blueMasked : bool
greenMasked : bool
redMasked : bool

Public Functions

	QColorMask(Qt3DCore::QNode *parent = nullptr)
bool	isAlphaMasked() const
bool	isBlueMasked() const
bool	isGreenMasked() const
bool	isRedMasked() const

Public Slots

void	setAlphaMasked(bool alphaMasked)
void	setBlueMasked(bool blueMasked)
void	setGreenMasked(bool greenMasked)
void	setRedMasked(bool redMasked)

Signals

void	alphaMaskedChanged(bool alphaMasked)
void	blueMaskedChanged(bool blueMasked)
void	greenMaskedChanged(bool greenMasked)
void	redMaskedChanged(bool redMasked)

Detailed Description

By default, the property for each color component (red, green, blue, alpha) is set to true which means they will be written to the frame buffer. Setting any of the color component to false will prevent it from being written into the frame buffer.

Property Documentation

alphaMasked : bool

Holds whether the alphaMasked component should be written to the frame buffer.

Access functions:

bool	isAlphaMasked() const
void	setAlphaMasked(bool alphaMasked)

Notifier signal:

void	alphaMaskedChanged(bool alphaMasked)

blueMasked : bool

Holds whether the blue color component should be written to the frame buffer.

Access functions:

bool	isBlueMasked() const
void	setBlueMasked(bool blueMasked)

Notifier signal:

void	blueMaskedChanged(bool blueMasked)

greenMasked : bool

Holds whether the green color component should be written to the frame buffer.

Access functions:

bool	isGreenMasked() const
void	setGreenMasked(bool greenMasked)

Notifier signal:

void	greenMaskedChanged(bool greenMasked)

redMasked : bool

Holds whether the red color component should be written to the frame buffer.

Access functions:

bool	isRedMasked() const
void	setRedMasked(bool redMasked)

Notifier signal:

void	redMaskedChanged(bool redMasked)

Member Function Documentation

QColorMask::QColorMask(Qt3DCore::QNode **parent* = nullptr)

Constructs a new Qt3DCore::QColorMask instance with parent as parent.

Contents

QColorMask Class

Properties

Public Functions

Public Slots

Signals

Detailed Description

Property Documentation

alphaMasked : bool

blueMasked : bool

greenMasked : bool

redMasked : bool

Member Function Documentation

QColorMask::QColorMask(Qt3DCore::QNode *parent = nullptr)

Sign Up and Download for Free

QColorMask::QColorMask(Qt3DCore::QNode **parent* = nullptr)