PySide6.Qt3DExtras.Qt3DExtras.QSkyboxEntity

class QSkyboxEntity

QSkyboxEntity is a convenience QEntity subclass that can be used to insert a skybox in a 3D scene. More…

Synopsis

Properties

• baseNameᅟ

• extensionᅟ

• gammaCorrectᅟ

Methods

• def __init__()

• def baseName()

• def extension()

• def isGammaCorrectEnabled()

Slots

• def setBaseName()

• def setExtension()

• def setGammaCorrectEnabled()

Signals

• def baseNameChanged()

• def extensionChanged()

• def gammaCorrectEnabledChanged()

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.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property baseNameᅟ: str

Contains the base name of the Skybox.

Access functions:

• baseName()

• setBaseName()

• Signal baseNameChanged()

property extensionᅟ: str

Contains the extension of the filename for the skybox image, including the leading ‘.’.

The default value is: .png

Access functions:

• extension()

• setExtension()

• Signal extensionChanged()

property gammaCorrectᅟ: bool

A boolean indicating whether gamma correction is enabled.

Access functions:

• isGammaCorrectEnabled()

• setGammaCorrectEnabled()

• Signal gammaCorrectEnabledChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new QSkyboxEntity object with parent as parent.

baseName()

Return type:

str

Returns the base name of the Skybox.

See also

setBaseName()

Getter of property baseNameᅟ .

baseNameChanged(path)

Parameters:

path – str

Notification signal of property baseNameᅟ .

extension()

Return type:

str

Returns the extension

See also

setExtension()

Getter of property extensionᅟ .

extensionChanged(extension)

Parameters:

extension – str

Notification signal of property extensionᅟ .

gammaCorrectEnabledChanged(enabled)

Parameters:

enabled – bool

Notification signal of property gammaCorrectᅟ .

isGammaCorrectEnabled()

Return type:

bool

Returns true if gamma correction is enabled for this skybox.

Getter of property gammaCorrectᅟ .

setBaseName(path)

Parameters:

path – str

Sets the base name to baseName.

See also

baseName()

Setter of property baseNameᅟ .

setExtension(extension)

Parameters:

extension – str

Sets the extension to extension.

See also

extension()

Setter of property extensionᅟ .

setGammaCorrectEnabled(enabled)

Parameters:

enabled – bool

Sets the gamma correction enable state to enabled.

See also

isGammaCorrectEnabled()

Setter of property gammaCorrectᅟ .