QRhiDepthStencilClearValue Class
Specifies clear values for a depth or stencil buffer. More...
Header: | #include <rhi/qrhi.h> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::GuiPrivate) |
qmake: | QT += gui-private |
Since: | Qt 6.6 |
Public Functions
QRhiDepthStencilClearValue() | |
QRhiDepthStencilClearValue(float d, quint32 s) | |
float | depthClearValue() const |
void | setDepthClearValue(float d) |
void | setStencilClearValue(quint32 s) |
quint32 | stencilClearValue() const |
Related Non-Members
size_t | qHash(const QRhiDepthStencilClearValue &v, size_t seed = 0) |
bool | operator!=(const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b) |
bool | operator==(const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b) |
Detailed Description
Note: This is a RHI API with limited compatibility guarantees, see QRhi for details.
Member Function Documentation
[constexpr noexcept]
QRhiDepthStencilClearValue::QRhiDepthStencilClearValue()
Constructs a depth/stencil clear value with depth clear value 1.0f and stencil clear value 0.
QRhiDepthStencilClearValue::QRhiDepthStencilClearValue(float d, quint32 s)
Constructs a depth/stencil clear value with depth clear value d and stencil clear value s.
float QRhiDepthStencilClearValue::depthClearValue() const
Returns the depth clear value. In most cases this is 1.0f.
See also setDepthClearValue().
void QRhiDepthStencilClearValue::setDepthClearValue(float d)
Sets the depth clear value to d.
See also depthClearValue().
void QRhiDepthStencilClearValue::setStencilClearValue(quint32 s)
Sets the stencil clear value to s.
See also stencilClearValue().
quint32 QRhiDepthStencilClearValue::stencilClearValue() const
Returns the stencil clear value. In most cases this is 0.
See also setStencilClearValue().
Related Non-Members
[noexcept]
size_t qHash(const QRhiDepthStencilClearValue &v, size_t seed = 0)
Returns the hash value for v, using seed to seed the calculation.
[noexcept]
bool operator!=(const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b)
Returns false
if the values in the two QRhiDepthStencilClearValue objects a and b are equal; otherwise returns true
.
[noexcept]
bool operator==(const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b)
Returns true
if the values in the two QRhiDepthStencilClearValue objects a and b are equal.