QSkyboxEntity#
QSkyboxEntity is a convenience QEntity subclass that can be used to insert a skybox in a 3D scene. More…
Synopsis#
Properties#
Functions#
def
baseName()def
extension()def
isGammaCorrectEnabled()
Slots#
def
setBaseName(path)def
setExtension(extension)def
setGammaCorrectEnabled(enabled)
Signals#
def
baseNameChanged(path)def
extensionChanged(extension)def
gammaCorrectEnabledChanged(enabled)
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
By specifying a base name and an extension, QSkyboxEntity will take care of building a TextureCubeMap to be rendered at runtime. The images in the source directory should match the pattern: base name + * “_posx|_posy|_posz|_negx|_negy|_negz” + extension
By default the extension defaults to .png.
Be sure to disable frustum culling in the FrameGraph through which the skybox rendering happens.
Note
Please note that you shouldn’t try to render a skybox with an orthographic projection.
- class PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity([parent=None])#
- Parameters:
parent –
PySide6.Qt3DCore.Qt3DCore.QNode
Constructs a new QSkyboxEntity object with parent as parent.
Note
Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.
- property PᅟySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.baseName: str#
Contains the base name of the Skybox.
- Access functions:
baseName()setBaseName(path)Signal
baseNameChanged(path)
- property PᅟySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.extension: str#
Contains the extension of the filename for the skybox image, including the leading ‘.’.
The default value is: .png
- Access functions:
extension()setExtension(extension)Signal
extensionChanged(extension)
- property PᅟySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.gammaCorrect: bool#
A boolean indicating whether gamma correction is enabled.
- Access functions:
setGammaCorrectEnabled(enabled)Signal
gammaCorrectEnabledChanged(enabled)
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.baseName()#
- Return type:
str
Returns the base name of the Skybox.
See also
Getter of property baseName .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.baseNameChanged(path)#
- Parameters:
path – str
Notification signal of property baseName .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.extension()#
- Return type:
str
Returns the extension
See also
Getter of property extension .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.extensionChanged(extension)#
- Parameters:
extension – str
Notification signal of property extension .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.gammaCorrectEnabledChanged(enabled)#
- Parameters:
enabled – bool
Notification signal of property gammaCorrect .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.isGammaCorrectEnabled()#
- Return type:
bool
Returns true if gamma correction is enabled for this skybox.
Getter of property gammaCorrect .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.setBaseName(path)#
- Parameters:
path – str
Sets the base name to baseName.
See also
Setter of property baseName .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.setExtension(extension)#
- Parameters:
extension – str
Sets the extension to extension.
See also
Setter of property extension .
- PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity.setGammaCorrectEnabled(enabled)#
- Parameters:
enabled – bool
Sets the gamma correction enable state to enabled.
See also
Setter of property gammaCorrect .