Struct qt_3d_extras::QSkyboxEntity

#[repr(C)]pub struct QSkyboxEntity { /* fields omitted */ }

Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene.

C++ class: Qt3DExtras::QSkyboxEntity.

C++ documentation:

Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene.

By specifying a base name and an extension, Qt3DExtras::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.

Methods

impl QSkyboxEntity

pub fn slot_set_base_name(&self) -> Receiver<(*const QString,)>

Sets the base name to baseName.

Returns a built-in Qt slot Qt3DExtras::QSkyboxEntity::setBaseName that can be passed to qt_core::Signal::connect.

C++ documentation:

Sets the base name to baseName.

Note: Setter function for property baseName.

See also baseName().

pub fn slot_set_extension(&self) -> Receiver<(*const QString,)>

Sets the extension to extension.

Returns a built-in Qt slot Qt3DExtras::QSkyboxEntity::setExtension that can be passed to qt_core::Signal::connect.

C++ documentation:

Sets the extension to extension.

Note: Setter function for property extension.

See also extension().

pub fn slot_set_gamma_correct_enabled(&self) -> Receiver<(bool,)>

Sets the gamma correction enable state to enabled.

Returns a built-in Qt slot Qt3DExtras::QSkyboxEntity::setGammaCorrectEnabled that can be passed to qt_core::Signal::connect.

C++ documentation:

Sets the gamma correction enable state to enabled.

This function was introduced in Qt 5.9.

Note: Setter function for property gammaCorrect.

See also isGammaCorrectEnabled().

pub fn base_name_changed(&self) -> Signal<(*const QString,)>

Contains the base name of the Skybox.

Returns a built-in Qt signal Qt3DExtras::QSkyboxEntity::baseNameChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Contains the base name of the Skybox.

Access functions:

QString	baseName() const
void	setBaseName(const QString &baseName)

Notifier signal:

void	baseNameChanged(const QString &path)

pub fn extension_changed(&self) -> Signal<(*const QString,)>

Contains the extension of the Skybox.

Returns a built-in Qt signal Qt3DExtras::QSkyboxEntity::extensionChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Contains the extension of the Skybox.

Access functions:

QString	extension() const
void	setExtension(const QString &extension)

Notifier signal:

void	extensionChanged(const QString &extension)

pub fn gamma_correct_enabled_changed(&self) -> Signal<(bool,)>

A boolean indicating whether gamma correction is enabled.

Returns a built-in Qt signal Qt3DExtras::QSkyboxEntity::gammaCorrectEnabledChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

A boolean indicating whether gamma correction is enabled.

Access functions:

bool	isGammaCorrectEnabled() const
void	setGammaCorrectEnabled(bool enabled)

Notifier signal:

void	gammaCorrectEnabledChanged(bool enabled)

pub unsafe fn base_name(&self) -> CppBox<QString>

Contains the base name of the Skybox.

Calls C++ function: QString Qt3DExtras::QSkyboxEntity::baseName() const.

C++ documentation:

Contains the base name of the Skybox.

Access functions:

QString	baseName() const
void	setBaseName(const QString &baseName)

Notifier signal:

void	baseNameChanged(const QString &path)

pub unsafe fn extension(&self) -> CppBox<QString>

Contains the extension of the Skybox.

Calls C++ function: QString Qt3DExtras::QSkyboxEntity::extension() const.

C++ documentation:

Contains the extension of the Skybox.

Access functions:

QString	extension() const
void	setExtension(const QString &extension)

Notifier signal:

void	extensionChanged(const QString &extension)

pub unsafe fn is_gamma_correct_enabled(&self) -> bool

Returns true if gamma correction is enabled for this skybox.

Calls C++ function: bool Qt3DExtras::QSkyboxEntity::isGammaCorrectEnabled() const.

C++ documentation:

Returns true if gamma correction is enabled for this skybox.

This function was introduced in Qt 5.9.

Note: Getter function for property gammaCorrect.

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DExtras::QSkyboxEntity::metaObject() const.

pub unsafe fn new_1a(parent: impl CastInto<Ptr<QNode>>) -> QBox<QSkyboxEntity>

Default constructs an instance of QSkyboxEntity.

Calls C++ function: [constructor] void Qt3DExtras::QSkyboxEntity::QSkyboxEntity(Qt3DCore::QNode* parent = …).

C++ documentation:

Default constructs an instance of QSkyboxEntity.

pub unsafe fn new_0a() -> QBox<QSkyboxEntity>

Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene.

Calls C++ function: [constructor] void Qt3DExtras::QSkyboxEntity::QSkyboxEntity().

C++ documentation:

Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene.

By specifying a base name and an extension, Qt3DExtras::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.

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int Qt3DExtras::QSkyboxEntity::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* Qt3DExtras::QSkyboxEntity::qt_metacast(const char* arg1).

pub unsafe fn set_base_name(&self, path: impl CastInto<Ref<QString>>)

Sets the base name to baseName.

Calls C++ function: [slot] void Qt3DExtras::QSkyboxEntity::setBaseName(const QString& path).

C++ documentation:

Sets the base name to baseName.

Note: Setter function for property baseName.

See also baseName().

pub unsafe fn set_extension(&self, extension: impl CastInto<Ref<QString>>)

Sets the extension to extension.

Calls C++ function: [slot] void Qt3DExtras::QSkyboxEntity::setExtension(const QString& extension).

C++ documentation:

Sets the extension to extension.

Note: Setter function for property extension.

See also extension().

pub unsafe fn set_gamma_correct_enabled(&self, enabled: bool)

Sets the gamma correction enable state to enabled.

Calls C++ function: [slot] void Qt3DExtras::QSkyboxEntity::setGammaCorrectEnabled(bool enabled).

C++ documentation:

Sets the gamma correction enable state to enabled.

This function was introduced in Qt 5.9.

Note: Setter function for property gammaCorrect.

See also isGammaCorrectEnabled().

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DExtras::QSkyboxEntity::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DExtras::QSkyboxEntity::trUtf8(const char* s, const char* c, int n).

Trait Implementations

impl CppDeletable for QSkyboxEntity

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void Qt3DExtras::QSkyboxEntity::~QSkyboxEntity().

impl Deref for QSkyboxEntity

type Target = QEntity

The resulting type after dereferencing.

fn deref(&self) -> &QEntity

Calls C++ function: Qt3DCore::QEntity* static_cast<Qt3DCore::QEntity*>(Qt3DExtras::QSkyboxEntity* ptr).

impl DynamicCast<QSkyboxEntity> for QEntity

unsafe fn dynamic_cast(ptr: Ptr<QEntity>) -> Ptr<QSkyboxEntity>

Calls C++ function: Qt3DExtras::QSkyboxEntity* dynamic_cast<Qt3DExtras::QSkyboxEntity*>(Qt3DCore::QEntity* ptr).

impl DynamicCast<QSkyboxEntity> for QNode

unsafe fn dynamic_cast(ptr: Ptr<QNode>) -> Ptr<QSkyboxEntity>

Calls C++ function: Qt3DExtras::QSkyboxEntity* dynamic_cast<Qt3DExtras::QSkyboxEntity*>(Qt3DCore::QNode* ptr).

impl DynamicCast<QSkyboxEntity> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QSkyboxEntity>

Calls C++ function: Qt3DExtras::QSkyboxEntity* dynamic_cast<Qt3DExtras::QSkyboxEntity*>(QObject* ptr).

impl StaticDowncast<QSkyboxEntity> for QEntity

unsafe fn static_downcast(ptr: Ptr<QEntity>) -> Ptr<QSkyboxEntity>

Calls C++ function: Qt3DExtras::QSkyboxEntity* static_cast<Qt3DExtras::QSkyboxEntity*>(Qt3DCore::QEntity* ptr).

impl StaticDowncast<QSkyboxEntity> for QNode

unsafe fn static_downcast(ptr: Ptr<QNode>) -> Ptr<QSkyboxEntity>

Calls C++ function: Qt3DExtras::QSkyboxEntity* static_cast<Qt3DExtras::QSkyboxEntity*>(Qt3DCore::QNode* ptr).

impl StaticDowncast<QSkyboxEntity> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QSkyboxEntity>

Calls C++ function: Qt3DExtras::QSkyboxEntity* static_cast<Qt3DExtras::QSkyboxEntity*>(QObject* ptr).

impl StaticUpcast<QEntity> for QSkyboxEntity

unsafe fn static_upcast(ptr: Ptr<QSkyboxEntity>) -> Ptr<QEntity>

Calls C++ function: Qt3DCore::QEntity* static_cast<Qt3DCore::QEntity*>(Qt3DExtras::QSkyboxEntity* ptr).

impl StaticUpcast<QNode> for QSkyboxEntity

unsafe fn static_upcast(ptr: Ptr<QSkyboxEntity>) -> Ptr<QNode>

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DExtras::QSkyboxEntity* ptr).

impl StaticUpcast<QObject> for QSkyboxEntity

unsafe fn static_upcast(ptr: Ptr<QSkyboxEntity>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(Qt3DExtras::QSkyboxEntity* ptr).