Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QRhiTextureUploadEntry Class Reference

\inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h More...

#include <qrhi.h>

Collaboration diagram for QRhiTextureUploadEntry:

Public Member Functions

 QRhiTextureUploadEntry ()=default
 Constructs an empty QRhiTextureUploadEntry targeting layer 0 and level 0.
 QRhiTextureUploadEntry (int layer, int level, const QRhiTextureSubresourceUploadDescription &desc)
 Constructs a QRhiTextureUploadEntry targeting the given layer and mip level, with the subresource contents described by desc.
int layer () const
void setLayer (int layer)
 Sets the layer.
int level () const
void setLevel (int level)
 Sets the mip level.
QRhiTextureSubresourceUploadDescription description () const
void setDescription (const QRhiTextureSubresourceUploadDescription &desc)
 Sets the subresource description desc.

Detailed Description

\inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h

Since
6.6

Describes one layer (face for cubemaps, slice for 3D textures, element for texture arrays) in a texture upload operation.

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

Definition at line 697 of file qrhi.h.

Constructor & Destructor Documentation

◆ QRhiTextureUploadEntry() [1/2]

QRhiTextureUploadEntry::QRhiTextureUploadEntry ( )
default

Constructs an empty QRhiTextureUploadEntry targeting layer 0 and level 0.

Note
an empty QRhiTextureUploadEntry should not be submitted without setting a QRhiTextureSubresourceUploadDescription via setDescription() first.

◆ QRhiTextureUploadEntry() [2/2]

QRhiTextureUploadEntry::QRhiTextureUploadEntry ( int layer,
int level,
const QRhiTextureSubresourceUploadDescription & desc )

Constructs a QRhiTextureUploadEntry targeting the given layer and mip level, with the subresource contents described by desc.

Definition at line 3094 of file qrhi.cpp.

Member Function Documentation

◆ description()

QRhiTextureSubresourceUploadDescription QRhiTextureUploadEntry::description ( ) const
inline
Returns
the currently set subresource description.

Definition at line 709 of file qrhi.h.

◆ layer()

int QRhiTextureUploadEntry::layer ( ) const
inline
Returns
the currently set layer index (cubemap face, array layer). Defaults to 0.

Definition at line 703 of file qrhi.h.

◆ level()

int QRhiTextureUploadEntry::level ( ) const
inline
Returns
the currently set mip level. Defaults to 0.

Definition at line 706 of file qrhi.h.

◆ setDescription()

void QRhiTextureUploadEntry::setDescription ( const QRhiTextureSubresourceUploadDescription & desc)
inline

Sets the subresource description desc.

Definition at line 710 of file qrhi.h.

◆ setLayer()

void QRhiTextureUploadEntry::setLayer ( int layer)
inline

Sets the layer.

Definition at line 704 of file qrhi.h.

◆ setLevel()

void QRhiTextureUploadEntry::setLevel ( int level)
inline

Sets the mip level.

Definition at line 707 of file qrhi.h.


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