QRhiDepthStencilClearValue Class Reference

\inmodule QtGui More...

#include <qrhi.h>

Collaboration diagram for QRhiDepthStencilClearValue:

Public Member Functions
	QRhiDepthStencilClearValue ()=default
	Constructs a depth/stencil clear value with depth clear value 1.0f and stencil clear value 0.
	QRhiDepthStencilClearValue (float d, quint32 s)
	Constructs a depth/stencil clear value with depth clear value d and stencil clear value s.
float	depthClearValue () const
void	setDepthClearValue (float d)
	Sets the depth clear value to d.
quint32	stencilClearValue () const
void	setStencilClearValue (quint32 s)
	Sets the stencil clear value to s.

Friends
bool	operator== (const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b) noexcept
bool	operator!= (const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b) noexcept
size_t	qHash (const QRhiDepthStencilClearValue &v, size_t seed=0) noexcept

Detailed Description

\inmodule QtGui

Since

6.6

Specifies clear values for a depth or stencil buffer.

Note

This is a RHI API with limited compatibility guarantees, see \l QRhi for details.

Definition at line 43 of file qrhi.h.

Constructor & Destructor Documentation

QRhiDepthStencilClearValue() [1/2]

QRhiDepthStencilClearValue::QRhiDepthStencilClearValue ( )

default

Constructs a depth/stencil clear value with depth clear value 1.0f and stencil clear value 0.

QRhiDepthStencilClearValue() [2/2]

QRhiDepthStencilClearValue::QRhiDepthStencilClearValue	(	float	d,
		quint32	s
	)

Constructs a depth/stencil clear value with depth clear value d and stencil clear value s.

Definition at line 1134 of file qrhi.cpp.

Member Function Documentation

depthClearValue()

float QRhiDepthStencilClearValue::depthClearValue ( ) const

inline

Returns

the depth clear value. In most cases this is 1.0f.

Definition at line 49 of file qrhi.h.

Referenced by QRhiD3D11::beginPass(), QRhiGles2::beginPass(), QRhiVulkan::beginPass(), and QRhiMetalData::createDefaultRenderPass().

Here is the caller graph for this function:

setDepthClearValue()

void QRhiDepthStencilClearValue::setDepthClearValue ( float  d )

inline

Sets the depth clear value to d.

Definition at line 50 of file qrhi.h.

References d.

setStencilClearValue()

void QRhiDepthStencilClearValue::setStencilClearValue ( quint32  s )

inline

Sets the stencil clear value to s.

Definition at line 53 of file qrhi.h.

stencilClearValue()

quint32 QRhiDepthStencilClearValue::stencilClearValue ( ) const

inline

Returns

the stencil clear value. In most cases this is 0.

Definition at line 52 of file qrhi.h.

Referenced by QRhiD3D11::beginPass(), QRhiGles2::beginPass(), QRhiVulkan::beginPass(), and QRhiMetalData::createDefaultRenderPass().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator!=

bool QRhiDepthStencilClearValue::operator!= ( const QRhiDepthStencilClearValue &  a, const QRhiDepthStencilClearValue &  b  )

friend

Returns

false if the values in the two QRhiDepthStencilClearValue objects a and b are equal; otherwise returns true.

Definition at line 64 of file qrhi.h.

operator==

bool QRhiDepthStencilClearValue::operator== ( const QRhiDepthStencilClearValue &  a, const QRhiDepthStencilClearValue &  b  )

friend

Returns

true if the values in the two QRhiDepthStencilClearValue objects a and b are equal.

Definition at line 59 of file qrhi.h.

qHash

size_t QRhiDepthStencilClearValue::qHash ( const QRhiDepthStencilClearValue &  v, size_t  seed = 0  )

friend

Returns

the hash value for v, using seed to seed the calculation.

Definition at line 69 of file qrhi.h.

---

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

• qtbase/src/gui/rhi/qrhi.h
• qtbase/src/gui/rhi/qrhi.cpp