QRhiTextureCopyDescription Class Reference

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

#include <qrhi.h>

Collaboration diagram for QRhiTextureCopyDescription:

Public Member Functions
	QRhiTextureCopyDescription ()=default
	Constructs an empty texture copy description.
QSize	pixelSize () const
void	setPixelSize (const QSize &sz)
	Sets the size of the region to copy to sz.
int	sourceLayer () const
void	setSourceLayer (int layer)
	Sets the source array layer.
int	sourceLevel () const
void	setSourceLevel (int level)
	Sets the source mip level.
QPoint	sourceTopLeft () const
void	setSourceTopLeft (const QPoint &p)
	Sets the source top-left position to p.
int	destinationLayer () const
void	setDestinationLayer (int layer)
	Sets the destination array layer.
int	destinationLevel () const
void	setDestinationLevel (int level)
	Sets the destination mip level.
QPoint	destinationTopLeft () const
void	setDestinationTopLeft (const QPoint &p)
	Sets the destination top-left position p.

Detailed Description

\inmodule QtGuiPrivate \inheaderfile rhi/qrhi.h

Since

6.6

Describes a texture-to-texture copy operation.

An empty pixelSize() indicates that the entire subresource is to be copied. A default constructed copy description therefore leads to copying the entire subresource at level 0 of layer 0.

Note

The source texture must be created with QRhiTexture::UsedAsTransferSource.

The source and destination rectangles defined by pixelSize(), sourceTopLeft(), and destinationTopLeft() must fit the source and destination textures, respectively. The behavior is undefined otherwise.

With cubemaps, 3D textures, and texture arrays one face or slice can be copied at a time. The face or slice is specified by the source and destination layer indices. With mipmapped textures one mip level can be copied at a time. The source and destination layer and mip level indices can differ, but the size and position must be carefully controlled to avoid out of bounds copies, in which case the behavior is undefined.

Note

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

Definition at line 743 of file qrhi.h.

Constructor & Destructor Documentation

QRhiTextureCopyDescription()

QRhiTextureCopyDescription::QRhiTextureCopyDescription ( )

default

Constructs an empty texture copy description.

Member Function Documentation

destinationLayer()

int QRhiTextureCopyDescription::destinationLayer ( ) const

inline

Returns

the destination array layer (cubemap face or array layer index). Default to 0.

Definition at line 760 of file qrhi.h.

destinationLevel()

int QRhiTextureCopyDescription::destinationLevel ( ) const

inline

Returns

the destionation mip level. Defaults to 0.

Definition at line 763 of file qrhi.h.

destinationTopLeft()

QPoint QRhiTextureCopyDescription::destinationTopLeft ( ) const

inline

Returns

the destionation top-left position in pixels. Defaults to (0, 0).

Definition at line 766 of file qrhi.h.

pixelSize()

QSize QRhiTextureCopyDescription::pixelSize ( ) const

inline

Returns

the size of the region to copy.

Note

An empty pixelSize() indicates that the entire subresource is to be copied. A default constructed copy description therefore leads to copying the entire subresource at level 0 of layer 0.

Definition at line 748 of file qrhi.h.

setDestinationLayer()

void QRhiTextureCopyDescription::setDestinationLayer ( int layer )

inline

Sets the destination array layer.

Definition at line 761 of file qrhi.h.

setDestinationLevel()

void QRhiTextureCopyDescription::setDestinationLevel ( int level )

inline

Sets the destination mip level.

Definition at line 764 of file qrhi.h.

setDestinationTopLeft()

void QRhiTextureCopyDescription::setDestinationTopLeft ( const QPoint & p )

inline

Sets the destination top-left position p.

Definition at line 767 of file qrhi.h.

setPixelSize()

void QRhiTextureCopyDescription::setPixelSize ( const QSize & sz )

inline

Sets the size of the region to copy to sz.

Definition at line 749 of file qrhi.h.

setSourceLayer()

void QRhiTextureCopyDescription::setSourceLayer ( int layer )

inline

Sets the source array layer.

Definition at line 752 of file qrhi.h.

setSourceLevel()

void QRhiTextureCopyDescription::setSourceLevel ( int level )

inline

Sets the source mip level.

Definition at line 755 of file qrhi.h.

setSourceTopLeft()

void QRhiTextureCopyDescription::setSourceTopLeft ( const QPoint & p )

inline

Sets the source top-left position to p.

Definition at line 758 of file qrhi.h.

sourceLayer()

int QRhiTextureCopyDescription::sourceLayer ( ) const

inline

Returns

the source array layer (cubemap face or array layer index). Defaults to 0.

Definition at line 751 of file qrhi.h.

sourceLevel()

int QRhiTextureCopyDescription::sourceLevel ( ) const

inline

Returns

the source mip level. Defaults to 0.

Definition at line 754 of file qrhi.h.

sourceTopLeft()

QPoint QRhiTextureCopyDescription::sourceTopLeft ( ) const

inline

Returns

the source top-left position (in pixels). Defaults to (0, 0).

Definition at line 757 of file qrhi.h.

---

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

• qtbase/src/gui/rhi/qrhi.h (73a18c3eba6fe5b4ff80f386028dd892da5944d6)
• qtbase/src/gui/rhi/qrhi.cpp (73a18c3eba6fe5b4ff80f386028dd892da5944d6)