QAbstractTexture

A base class to be used to provide textures. More…

Inheritance diagram of PySide2.Qt3DRender.Qt3DRender.QAbstractTexture

Inherited by: QSharedGLTexture, QTexture1D, QTexture1DArray, QTexture2D, QTexture2DArray, QTexture2DMultisample, QTexture2DMultisampleArray, QTexture3D, QTextureBuffer, QTextureCubeMap, QTextureCubeMapArray, QTextureLoader, QTextureRectangle

Synopsis

Functions

Slots

Signals

Detailed Description

The QAbstractTexture class shouldn’t be used directly but rather through one of its subclasses. Each subclass implements a given texture target (2D, 2DArray, 3D, CubeMap …) Each subclass provides a set of functors for each layer, cube map face and mipmap level. In turn the backend uses those functor to properly fill a corresponding OpenGL texture with data. It is expected the functor does as minimal processing as possible so as not to slow down textures generation and upload. If the content of a texture is the result of a slow procedural generation process, it is recommended not to implement this directly in a functor.

All textures are unique. If you instantiate twice the same texture this will create 2 identical textures on the GPU, no sharing will take place.

class PySide2.Qt3DRender.Qt3DRender.QAbstractTexture([parent=None])

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture(target[, parent=None])

param parent:

PySide2.Qt3DCore.Qt3DCore.QNode

param target:

Target

The constructor creates a new QAbstractTexture instance with the specified parent .

The constructor creates a new QAbstractTexture instance with the specified target and parent .

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.Status

Contains the status of the texture provider.

Constant

Description

Qt3DRender.QAbstractTexture.None

Qt3DRender.QAbstractTexture.Loading

Qt3DRender.QAbstractTexture.Ready

Qt3DRender.QAbstractTexture.Error
PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.Target

Constant

Description

Qt3DRender.QAbstractTexture.TargetAutomatic

Target will be determined by the Qt3D engine

Qt3DRender.QAbstractTexture.Target1D

GL_TEXTURE_1D

Qt3DRender.QAbstractTexture.Target1DArray

GL_TEXTURE_1D_ARRAY

Qt3DRender.QAbstractTexture.Target2D

GL_TEXTURE_2D

Qt3DRender.QAbstractTexture.Target2DArray

GL_TEXTURE_2D_ARRAY

Qt3DRender.QAbstractTexture.Target3D

GL_TEXTURE_3D

Qt3DRender.QAbstractTexture.TargetCubeMap

GL_TEXTURE_CUBE_MAP

Qt3DRender.QAbstractTexture.TargetCubeMapArray

GL_TEXTURE_CUBE_MAP_ARRAY

Qt3DRender.QAbstractTexture.Target2DMultisample

GL_TEXTURE_2D_MULTISAMPLE

Qt3DRender.QAbstractTexture.Target2DMultisampleArray

GL_TEXTURE_2D_MULTISAMPLE_ARRAY

Qt3DRender.QAbstractTexture.TargetRectangle

GL_TEXTURE_RECTANGLE

Qt3DRender.QAbstractTexture.TargetBuffer

GL_TEXTURE_BUFFER
PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.TextureFormat

This list describes all possible texture formats

Constant

Description

Qt3DRender.QAbstractTexture.NoFormat

GL_NONE

Qt3DRender.QAbstractTexture.Automatic

automatically_determines_format

Qt3DRender.QAbstractTexture.R8_UNorm

GL_R8

Qt3DRender.QAbstractTexture.RG8_UNorm

GL_RG8

Qt3DRender.QAbstractTexture.RGB8_UNorm

GL_RGB8

Qt3DRender.QAbstractTexture.RGBA8_UNorm

GL_RGBA8

Qt3DRender.QAbstractTexture.R16_UNorm

GL_R16

Qt3DRender.QAbstractTexture.RG16_UNorm

GL_RG16

Qt3DRender.QAbstractTexture.RGB16_UNorm

GL_RGB16

Qt3DRender.QAbstractTexture.RGBA16_UNorm

GL_RGBA16

Qt3DRender.QAbstractTexture.R8_SNorm

GL_R8_SNORM

Qt3DRender.QAbstractTexture.RG8_SNorm

GL_RG8_SNORM

Qt3DRender.QAbstractTexture.RGB8_SNorm

GL_RGB8_SNORM

Qt3DRender.QAbstractTexture.RGBA8_SNorm

GL_RGBA8_SNORM

Qt3DRender.QAbstractTexture.R16_SNorm

GL_R16_SNORM

Qt3DRender.QAbstractTexture.RG16_SNorm

GL_RG16_SNORM

Qt3DRender.QAbstractTexture.RGB16_SNorm

GL_RGB16_SNORM

Qt3DRender.QAbstractTexture.RGBA16_SNorm

GL_RGBA16_SNORM

Qt3DRender.QAbstractTexture.R8U

GL_R8UI

Qt3DRender.QAbstractTexture.RG8U

GL_RG8UI

Qt3DRender.QAbstractTexture.RGB8U

GL_RGB8UI

Qt3DRender.QAbstractTexture.RGBA8U

GL_RGBA8UI

Qt3DRender.QAbstractTexture.R16U

GL_R16UI

Qt3DRender.QAbstractTexture.RG16U

GL_RG16UI

Qt3DRender.QAbstractTexture.RGB16U

GL_RGB16UI

Qt3DRender.QAbstractTexture.RGBA16U

GL_RGBA16UI

Qt3DRender.QAbstractTexture.R32U

GL_R32UI

Qt3DRender.QAbstractTexture.RG32U

GL_RG32UI

Qt3DRender.QAbstractTexture.RGB32U

GL_RGB32UI

Qt3DRender.QAbstractTexture.RGBA32U

GL_RGBA32UI

Qt3DRender.QAbstractTexture.R8I

GL_R8I

Qt3DRender.QAbstractTexture.RG8I

GL_RG8I

Qt3DRender.QAbstractTexture.RGB8I

GL_RGB8I

Qt3DRender.QAbstractTexture.RGBA8I

GL_RGBA8I

Qt3DRender.QAbstractTexture.R16I

GL_R16I

Qt3DRender.QAbstractTexture.RG16I

GL_RG16I

Qt3DRender.QAbstractTexture.RGB16I

GL_RGB16I

Qt3DRender.QAbstractTexture.RGBA16I

GL_RGBA16I

Qt3DRender.QAbstractTexture.R32I

GL_R32I

Qt3DRender.QAbstractTexture.RG32I

GL_RG32I

Qt3DRender.QAbstractTexture.RGB32I

GL_RGB32I

Qt3DRender.QAbstractTexture.RGBA32I

GL_RGBA32I

Qt3DRender.QAbstractTexture.R16F

GL_R16F

Qt3DRender.QAbstractTexture.RG16F

GL_RG16F

Qt3DRender.QAbstractTexture.RGB16F

GL_RGB16F

Qt3DRender.QAbstractTexture.RGBA16F

GL_RGBA16F

Qt3DRender.QAbstractTexture.R32F

GL_R32F

Qt3DRender.QAbstractTexture.RG32F

GL_RG32F

Qt3DRender.QAbstractTexture.RGB32F

GL_RGB32F

Qt3DRender.QAbstractTexture.RGBA32F

GL_RGBA32F

Qt3DRender.QAbstractTexture.RGB9E5

GL_RGB9_E5

Qt3DRender.QAbstractTexture.RG11B10F

GL_R11F_G11F_B10F

Qt3DRender.QAbstractTexture.RG3B2

GL_R3_G3_B2

Qt3DRender.QAbstractTexture.R5G6B5

GL_RGB565

Qt3DRender.QAbstractTexture.RGB5A1

GL_RGB5_A1

Qt3DRender.QAbstractTexture.RGBA4

GL_RGBA4

Qt3DRender.QAbstractTexture.RGB10A2

GL_RGB10_A2

Qt3DRender.QAbstractTexture.RGB10A2U

GL_RGB10_A2UI

Qt3DRender.QAbstractTexture.D16

GL_DEPTH_COMPONENT16

Qt3DRender.QAbstractTexture.D24

GL_DEPTH_COMPONENT24

Qt3DRender.QAbstractTexture.D24S8

GL_DEPTH24_STENCIL8

Qt3DRender.QAbstractTexture.D32

GL_DEPTH_COMPONENT32

Qt3DRender.QAbstractTexture.D32F

GL_DEPTH_COMPONENT32F

Qt3DRender.QAbstractTexture.D32FS8X24

GL_DEPTH32F_STENCIL8

Qt3DRender.QAbstractTexture.RGB_DXT1

GL_COMPRESSED_RGB_S3TC_DXT1_EXT

Qt3DRender.QAbstractTexture.RGBA_DXT1

GL_COMPRESSED_RGBA_S3TC_DXT1_EXT

Qt3DRender.QAbstractTexture.RGBA_DXT3

GL_COMPRESSED_RGBA_S3TC_DXT3_EXT

Qt3DRender.QAbstractTexture.RGBA_DXT5

GL_COMPRESSED_RGBA_S3TC_DXT5_EXT

Qt3DRender.QAbstractTexture.R_ATI1N_UNorm

GL_COMPRESSED_RED_RGTC1

Qt3DRender.QAbstractTexture.R_ATI1N_SNorm

GL_COMPRESSED_SIGNED_RED_RGTC1

Qt3DRender.QAbstractTexture.RG_ATI2N_UNorm

GL_COMPRESSED_RG_RGTC2

Qt3DRender.QAbstractTexture.RG_ATI2N_SNorm

GL_COMPRESSED_SIGNED_RG_RGTC2

Qt3DRender.QAbstractTexture.RGB_BP_UNSIGNED_FLOAT

GL_COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT_ARB

Qt3DRender.QAbstractTexture.RGB_BP_SIGNED_FLOAT

GL_COMPRESSED_RGB_BPTC_SIGNED_FLOAT_ARB

Qt3DRender.QAbstractTexture.RGB_BP_UNorm

GL_COMPRESSED_RGBA_BPTC_UNORM_ARB

Qt3DRender.QAbstractTexture.R11_EAC_UNorm

GL_COMPRESSED_R11_EAC

Qt3DRender.QAbstractTexture.R11_EAC_SNorm

GL_COMPRESSED_SIGNED_R11_EAC

Qt3DRender.QAbstractTexture.RG11_EAC_UNorm

GL_COMPRESSED_RG11_EAC

Qt3DRender.QAbstractTexture.RG11_EAC_SNorm

GL_COMPRESSED_SIGNED_RG11_EAC

Qt3DRender.QAbstractTexture.RGB8_ETC2

GL_COMPRESSED_RGB8_ETC2

Qt3DRender.QAbstractTexture.SRGB8_ETC2

GL_COMPRESSED_SRGB8_ETC2

Qt3DRender.QAbstractTexture.RGB8_PunchThrough_Alpha1_ETC2

GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2

Qt3DRender.QAbstractTexture.SRGB8_PunchThrough_Alpha1_ETC2

GL_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2

Qt3DRender.QAbstractTexture.RGBA8_ETC2_EAC

GL_COMPRESSED_RGBA8_ETC2_EAC

Qt3DRender.QAbstractTexture.SRGB8_Alpha8_ETC2_EAC

GL_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC

Qt3DRender.QAbstractTexture.RGB8_ETC1

GL_ETC1_RGB8_OES

Qt3DRender.QAbstractTexture.SRGB8

GL_SRGB8

Qt3DRender.QAbstractTexture.SRGB8_Alpha8

GL_SRGB8_ALPHA8

Qt3DRender.QAbstractTexture.SRGB_DXT1

GL_COMPRESSED_SRGB_S3TC_DXT1_EXT

Qt3DRender.QAbstractTexture.SRGB_Alpha_DXT1

GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT1_EXT

Qt3DRender.QAbstractTexture.SRGB_Alpha_DXT3

GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT3_EXT

Qt3DRender.QAbstractTexture.SRGB_Alpha_DXT5

GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT5_EXT

Qt3DRender.QAbstractTexture.SRGB_BP_UNorm

GL_COMPRESSED_SRGB_ALPHA_BPTC_UNORM_ARB

Qt3DRender.QAbstractTexture.DepthFormat

GL_DEPTH_COMPONENT

Qt3DRender.QAbstractTexture.AlphaFormat

GL_ALPHA

Qt3DRender.QAbstractTexture.RGBFormat

GL_RGB

Qt3DRender.QAbstractTexture.RGBAFormat

GL_RGBA

Qt3DRender.QAbstractTexture.LuminanceFormat

GL_LUMINANCE

Qt3DRender.QAbstractTexture.LuminanceAlphaFormat

0x190A
PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.Filter

Holds the filter type of the texture provider.

Constant

Description

Qt3DRender.QAbstractTexture.Nearest

GL_NEAREST

Qt3DRender.QAbstractTexture.Linear

GL_LINEAR

Qt3DRender.QAbstractTexture.NearestMipMapNearest

GL_NEAREST_MIPMAP_NEAREST

Qt3DRender.QAbstractTexture.NearestMipMapLinear

GL_NEAREST_MIPMAP_LINEAR

Qt3DRender.QAbstractTexture.LinearMipMapNearest

GL_LINEAR_MIPMAP_NEAREST

Qt3DRender.QAbstractTexture.LinearMipMapLinear

GL_LINEAR_MIPMAP_LINEAR
PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.CubeMapFace

This enum identifies the faces of a cube map texture

Constant

Description

Qt3DRender.QAbstractTexture.CubeMapPositiveX

Specify the positive X face of a cube map

Qt3DRender.QAbstractTexture.CubeMapNegativeX

Specify the negative X face of a cube map

Qt3DRender.QAbstractTexture.CubeMapPositiveY

Specify the positive Y face of a cube map

Qt3DRender.QAbstractTexture.CubeMapNegativeY

Specify the negative Y face of a cube map

Qt3DRender.QAbstractTexture.CubeMapPositiveZ

Specify the positive Z face of a cube map

Qt3DRender.QAbstractTexture.CubeMapNegativeZ

Specify the negative Z face of a cube map

Qt3DRender.QAbstractTexture.AllFaces

Specify all the faces of a cube map

Note

should only be used when a behavior needs to be applied to all the faces of a cubemap. This is the case for example when using a cube map as a texture attachment. Using in the attachment specfication would result in all faces being bound to the attachment point. On the other hand, if a specific face is specified, the attachment would only be using the specified face.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.ComparisonFunction
PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.ComparisonMode
PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.HandleType

New in version 5.13.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.addTextureImage(textureImage)
Parameters:

textureImage – PySide2.Qt3DRender.Qt3DRender.QAbstractTextureImage

Adds a new Qt3DCore::QAbstractTextureImage textureImage to the texture provider.

Note

QAbstractTextureImage should never be shared between multiple QAbstractTexture instances.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.comparisonFunction()
Return type:

ComparisonFunction

Holds the comparison function of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.comparisonFunctionChanged(comparisonFunction)
Parameters:

comparisonFunction – ComparisonFunction

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.comparisonMode()
Return type:

ComparisonMode

Holds the comparison mode of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.comparisonModeChanged(comparisonMode)
Parameters:

comparisonMode – ComparisonMode

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.dataGenerator()
Return type:

QSharedPointer

Note

This function is deprecated.

Returns the current data generator.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.depth()
Return type:

int

Holds the depth of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.depthChanged(depth)
Parameters:

depth – int

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.format()
Return type:

TextureFormat

Holds the format of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.formatChanged(format)
Parameters:

format – TextureFormat

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.generateMipMaps()
Return type:

bool

Holds whether the texture provider should auto generate mipmaps.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.generateMipMapsChanged(generateMipMaps)
Parameters:

generateMipMaps – bool

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.handle()
Return type:

object

Holds the current texture handle, if Qt 3D is using the OpenGL renderer, handle is a texture id integer.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.handleChanged(handle)
Parameters:

handle – object

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.handleType()
Return type:

HandleType

Holds the current texture handle type.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.handleTypeChanged(handleType)
Parameters:

handleType – HandleType

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.height()
Return type:

int

Holds the height of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.heightChanged(height)
Parameters:

height – int

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.layers()
Return type:

int

Holds the maximum layer count of the texture provider. By default, the maximum layer count is 1.

Note

this has a meaning only for texture providers that have 3D or array target formats.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.layersChanged(layers)
Parameters:

layers – int

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.magnificationFilter()
Return type:

Filter

Holds the magnification filter of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.magnificationFilterChanged(magnificationFilter)
Parameters:

magnificationFilter – Filter

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.maximumAnisotropy()
Return type:

float

Holds the maximum anisotropy of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.maximumAnisotropyChanged(maximumAnisotropy)
Parameters:

maximumAnisotropy – float

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.minificationFilter()
Return type:

Filter

Holds the minification filter of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.minificationFilterChanged(minificationFilter)
Parameters:

minificationFilter – Filter

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.removeTextureImage(textureImage)
Parameters:

textureImage – PySide2.Qt3DRender.Qt3DRender.QAbstractTextureImage

Removes a Qt3DCore::QAbstractTextureImage textureImage from the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.samples()
Return type:

int

Holds the number of samples per texel for the texture provider. By default, the number of samples is 1.

Note

this has a meaning only for texture providers that have multisample formats.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.samplesChanged(samples)
Parameters:

samples – int

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setComparisonFunction(function)
Parameters:

function – ComparisonFunction

Holds the comparison function of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setComparisonMode(mode)
Parameters:

mode – ComparisonMode

Holds the comparison mode of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setDepth(depth)
Parameters:

depth – int

Holds the depth of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setFormat(format)
Parameters:

format – TextureFormat

Holds the format of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setGenerateMipMaps(gen)
Parameters:

gen – bool

Holds whether the texture provider should auto generate mipmaps.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setHandle(handle)
Parameters:

handle – object

See also

handle()

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setHandleType(type)
Parameters:

type – HandleType

See also

handleType()

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setHeight(height)
Parameters:

height – int

Holds the height of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setLayers(layers)
Parameters:

layers – int

Holds the maximum layer count of the texture provider. By default, the maximum layer count is 1.

Note

this has a meaning only for texture providers that have 3D or array target formats.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setMagnificationFilter(f)
Parameters:

f – Filter

Holds the magnification filter of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setMaximumAnisotropy(anisotropy)
Parameters:

anisotropy – float

Holds the maximum anisotropy of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setMinificationFilter(f)
Parameters:

f – Filter

Holds the minification filter of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setSamples(samples)
Parameters:

samples – int

Holds the number of samples per texel for the texture provider. By default, the number of samples is 1.

Note

this has a meaning only for texture providers that have multisample formats.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setSize(width[, height=1[, depth=1]])
Parameters:

  • width – int

  • height – int

  • depth – int

Sets the size of the texture provider to width w , height h and depth d .

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setStatus(status)
Parameters:

status – Status

Set the status of the texture provider to the specified status .

See also

status()

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setWidth(width)
Parameters:

width – int

Holds the width of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.setWrapMode(wrapMode)
Parameters:

wrapMode – PySide2.Qt3DRender.Qt3DRender.QTextureWrapMode

Set the wrapmode to the value specified in wrapMode .

See also

wrapMode()

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.status()
Return type:

Status

Holds the current status of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.statusChanged(status)
Parameters:

status – Status

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.target()
Return type:

Target

Holds the target format of the texture provider.

Note

The target format can only be set once.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.textureImages()
Return type:

Returns a list of pointers to QAbstractTextureImage objects contained in the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.width()
Return type:

int

Holds the width of the texture provider.

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.widthChanged(width)
Parameters:

width – int

PySide2.Qt3DRender.Qt3DRender.QAbstractTexture.wrapMode()
Return type:

PySide2.Qt3DRender.Qt3DRender.QTextureWrapMode

Holds the wrap mode of the texture provider.