PySide6.Qt3DRender.Qt3DRender.QEnvironmentLight

class QEnvironmentLight

Encapsulate an environment light object in a Qt 3D scene. More…

Synopsis

Properties

• irradianceᅟ

• specularᅟ

Methods

• def __init__()

• def irradiance()

• def specular()

Slots

• def setIrradiance()

• def setSpecular()

Signals

• def irradianceChanged()

• def specularChanged()

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

QEnvironmentLight uses cubemaps to implement image-based lighting (IBL), a technique often used in conjunction with physically-based rendering (PBR). The cubemaps are typically expected be based on high dynamic range (HDR) images, with a suitable OpenGL format (such as RGBA16F) that can handle the increased range of values.

There are a variety of tools that can be used to produce the cubemaps needed by QEnvironmentLight . Some examples include

• cmftStudio

• IBLBaker

• Lys

HDRI Haven provides many CC0-licensed HDR images that can be used as source material for the above tools.

Note

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

property irradianceᅟ: QAbstractTexture

Holds the current environment irradiance map texture.

By default, the environment irradiance texture is null.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:

• irradiance()

• setIrradiance()

• Signal irradianceChanged()

property specularᅟ: QAbstractTexture

Holds the current environment specular map texture.

By default, the environment specular texture is null.

Note

The exact meaning and use of this property is up to the material implementation.

Access functions:

• specular()

• setSpecular()

• Signal specularChanged()

__init__([parent=None])

Parameters:

parent – QNode

irradiance()

Return type:

QAbstractTexture

See also

setIrradiance()

Getter of property irradianceᅟ .

irradianceChanged(environmentIrradiance)

Parameters:

environmentIrradiance – QAbstractTexture

Notification signal of property irradianceᅟ .

setIrradiance(irradiance)

Parameters:

irradiance – QAbstractTexture

See also

irradiance()

Setter of property irradianceᅟ .

setSpecular(specular)

Parameters:

specular – QAbstractTexture

See also

specular()

Setter of property specularᅟ .

specular()

Return type:

QAbstractTexture

See also

setSpecular()

Getter of property specularᅟ .

specularChanged(environmentSpecular)

Parameters:

environmentSpecular – QAbstractTexture

Notification signal of property specularᅟ .