Kuesa Runtime

Kuesa C++ Classes

The Kuesa module provides a set of helpers on top of Qt 3D to ease the Artist to Developer transition.

Namespaces

Classes

Kuesa::AbstractAssetCollection

An abstract base class for managing collections of assets in 3d models

Kuesa::AbstractPostProcessingEffect

The abstract base class for Kuesa post processing effects

Kuesa::AnimationClipCollection

A collection of assets of type Qt3DAnimation::QAbstractAnimationClip

Kuesa::AnimationMappingCollection

A collection of assets of type Qt3DAnimation::QChannelMapper

Kuesa::AnimationPlayer

Play animations defined in glTF files

Kuesa::ArmatureCollection

A collection of assets of type Qt3DCore::QArmature

Kuesa::BloomEffect

Post-processing effect for blurring the bright parts of a scene

Kuesa::CameraCollection

A collection of assets of type Qt3DRender::QCamera

Kuesa::DepthOfFieldEffect

Post-processing effect implementation of a depth of field

Kuesa::EffectCollection

A collection of assets of type Qt3DRender::QEffect

Kuesa::EntityCollection

A collection of assets of type Qt3DCore::QEntity

Kuesa::ForwardRenderer

Implements a simple forward rendering FrameGraph

Kuesa::FullScreenQuad

Convenience Qt3DCore::QEntity subclass use to create a full screen quad

Kuesa::GLTF2Import::GLTF2Options

Different options to configure the glTF 2.0 importer

Kuesa::GLTF2Importer

Imports glTF 2 scenes into a Qt 3D Scene

Kuesa::GLTF2Material

Subclass of Qt3DRender::QMaterial which is the base class of all GLTF2 based material subclasses

Kuesa::GLTF2MaterialEffect

Subclass of Qt3DRender::QEffect and is the base class of all GLTF2 based material effect subclasses

Kuesa::GLTF2MaterialProperties

Base class holding properties common to all glTF2 Materials

Kuesa::GaussianBlurEffect

Post-processing effect for blurring the scene

Kuesa::Iro2AlphaEquiRectEffect

Kuesa::Iro2AlphaEquiRectEffect is the effect for the Iro2AlphaEquiRectMaterial class

Kuesa::Iro2AlphaEquiRectMaterial

Kuesa::Iro2AlphaEquiRectMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and performs alpha blending. This variant uses a real normal map and equi-rectangular projection, see Iro2AlphaSem to use a fake normal map and SEM reflection

Kuesa::Iro2AlphaEquiRectProperties

Kuesa::Iro2AlphaEquiRectProperties holds the properties controlling the visual appearance of a Iro2AlphaEquiRectMaterial instance

Kuesa::Iro2AlphaSemEffect

Kuesa::Iro2AlphaSemEffect is the effect for the Iro2AlphaSemMaterial class

Kuesa::Iro2AlphaSemMaterial

Kuesa::Iro2AlphaSemMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and performs alpha blending. This variant uses a fake normal map and SEM reflection, see Iro2AlphaEquiRect to use a real normal map and equi-rectangular projection

Kuesa::Iro2AlphaSemProperties

Kuesa::Iro2AlphaSemProperties holds the properties controlling the visual appearance of a Iro2AlphaSemMaterial instance

Kuesa::Iro2DiffuseEquiRectEffect

Kuesa::Iro2DiffuseEquiRectEffect is the effect for the Iro2DiffuseEquiRectMaterial class

Kuesa::Iro2DiffuseEquiRectMaterial

Kuesa::Iro2DiffuseEquiRectMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and a 2d diffuse map to render semi glossy like finishes like clear coated paint. This variant uses a real normal map and equi-rectangular projection, see Iro2DiffuseSem to use a fake normal map and SEM reflection

Kuesa::Iro2DiffuseEquiRectProperties

Kuesa::Iro2DiffuseEquiRectProperties holds the properties controlling the visual appearance of a Iro2DiffuseEquiRectMaterial instance

Kuesa::Iro2DiffuseSemEffect

Kuesa::Iro2DiffuseSemEffect is the effect for the Iro2DiffuseSemMaterial class

Kuesa::Iro2DiffuseSemMaterial

Kuesa::Iro2DiffuseSemMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and a 2d diffuse map to render semi glossy like finishes like clear coated paint. This variant uses a fake normal map and SEM reflection, see Iro2DiffuseEquiRect to use a real normal map and equi-rectangular projection

Kuesa::Iro2DiffuseSemProperties

Kuesa::Iro2DiffuseSemProperties holds the properties controlling the visual appearance of a Iro2DiffuseSemMaterial instance

Kuesa::Iro2GlassEquiRectEffect

Kuesa::Iro2GlassEquiRectEffect is the effect for the Iro2GlassEquiRectMaterial class

Kuesa::Iro2GlassEquiRectMaterial

Kuesa::Iro2GlassEquiRectMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map to render transparent, glass like material. It performs 2 render passes. The first one performs multiplicative blending using the glass filter simulating the tint of the glass. The second pass performs additive blending for the reflections. This variant uses a real normal map and equi-rectangular projection, see Iro2GlassSem to use a fake normal map and SEM reflection

Kuesa::Iro2GlassEquiRectProperties

Kuesa::Iro2GlassEquiRectProperties holds the properties controlling the visual appearance of a Iro2GlassEquiRectMaterial instance

Kuesa::Iro2GlassSemEffect

Kuesa::Iro2GlassSemEffect is the effect for the Iro2GlassSemMaterial class

Kuesa::Iro2GlassSemMaterial

Kuesa::Iro2GlassSemMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map to render transparent, glass like material. It performs 2 render passes. The first one performs multiplicative blending using the glass filter simulating the tint of the glass. The second pass performs additive blending for the reflections. This variant uses a fake normal map and SEM reflection, see Iro2GlassEquiRect to use a real normal map and equi-rectangular projection

Kuesa::Iro2GlassSemProperties

Kuesa::Iro2GlassSemProperties holds the properties controlling the visual appearance of a Iro2GlassSemMaterial instance

Kuesa::Iro2MatteAlphaEffect

Kuesa::Iro2MatteAlphaEffect is the effect for the Iro2MatteAlphaMaterial class

Kuesa::Iro2MatteAlphaMaterial

Kuesa::Iro2MatteAlphaMaterial is a simple material in terms of rendering that perform lookups on a 2d map blended optionally with the per vertex color input

Kuesa::Iro2MatteAlphaProperties

Kuesa::Iro2MatteAlphaProperties holds the properties controlling the visual appearance of a Iro2MatteAlphaMaterial instance

Kuesa::Iro2PlanarReflectionEquiRectEffect

Kuesa::Iro2PlanarReflectionEquiRectEffect is the effect for the Iro2PlanarReflectionEquiRectMaterial class

Kuesa::Iro2PlanarReflectionEquiRectMaterial

Kuesa::Iro2PlanarReflectionEquiRectMaterial is a material dedicated to rendering reflection textures generated by ReflectionPlane defined on either a ForwardRenderer or View. This variant uses a real normal map and equi-rectangular projection

Kuesa::Iro2PlanarReflectionEquiRectProperties

Kuesa::Iro2PlanarReflectionEquiRectProperties holds the properties controlling the visual appearance of a Iro2PlanarReflectionEquiRectMaterial instance

Kuesa::Iro2PlanarReflectionSemEffect

Kuesa::Iro2PlanarReflectionSemEffect is the effect for the Iro2PlanarReflectionSemMaterial class

Kuesa::Iro2PlanarReflectionSemMaterial

Kuesa::Iro2PlanarReflectionSemMaterial is a material dedicated to rendering reflection textures generated by ReflectionPlane defined on either a ForwardRenderer or View. This variant uses a fake normal map and SEM reflection

Kuesa::Iro2PlanarReflectionSemProperties

Kuesa::Iro2PlanarReflectionSemProperties holds the properties controlling the visual appearance of a Iro2PlanarReflectionSemMaterial instance

Kuesa::IroDiffuseAlphaEffect

Kuesa::IroDiffuseAlphaEffect is the effect for the IroDiffuseAlphaMaterial class

Kuesa::IroDiffuseAlphaMaterial

Kuesa::IroDiffuseAlphaMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and performs alpha blending

Kuesa::IroDiffuseAlphaProperties

Kuesa::IroDiffuseAlphaProperties holds the properties controlling the visual appearance of a IroDiffuseAlphaMaterial instance

Kuesa::IroDiffuseEffect

Kuesa::IroDiffuseEffect is the effect for the IroDiffuseMaterial class

Kuesa::IroDiffuseHemiEffect

Kuesa::IroDiffuseHemiEffect is the effect for the IroDiffuseHemiMaterial class

Kuesa::IroDiffuseHemiMaterial

Kuesa::IroDiffuseHemiMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and a 2d diffuse map to render semi glossy like finishes like clear coated paint. It additionally shades the lower hemisphere by the color set in postHemiFilter

Kuesa::IroDiffuseHemiProperties

Kuesa::IroDiffuseHemiProperties holds the properties controlling the visual appearance of a IroDiffuseHemiMaterial instance

Kuesa::IroDiffuseMaterial

Kuesa::IroDiffuseMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map and a 2d diffuse map to render semi glossy like finishes like clear coated paint

Kuesa::IroDiffuseProperties

Kuesa::IroDiffuseProperties holds the properties controlling the visual appearance of a IroDiffuseMaterial instance

Kuesa::IroGlassAddEffect

Kuesa::IroGlassAddEffect is the effect for the IroGlassAddMaterial class

Kuesa::IroGlassAddMaterial

Kuesa::IroGlassAddMaterial is a simple material in terms of rendering that relies on a 2d spherical environment map to render transparent, glass like material. It performs 2 render passes. The first one performs multiplicative blending using the glass filter simulating the tint of the glass. The second pass performs additive blending for the reflections

Kuesa::IroGlassAddProperties

Kuesa::IroGlassAddProperties holds the properties controlling the visual appearance of a IroGlassAddMaterial instance

Kuesa::IroMatteAddEffect

Kuesa::IroMatteAddEffect is the effect for the IroMatteAddMaterial class

Kuesa::IroMatteAddMaterial

Kuesa::IroMatteAddMaterial is a simple material in terms of rendering that perform lookups on a 2d map optionally blended with the per vertex color input and performs additive color blending

Kuesa::IroMatteAddProperties

Kuesa::IroMatteAddProperties holds the properties controlling the visual appearance of a IroMatteAddMaterial instance

Kuesa::IroMatteAlphaEffect

Kuesa::IroMatteAlphaEffect is the effect for the IroMatteAlphaMaterial class

Kuesa::IroMatteAlphaMaterial

Kuesa::IroMatteAlphaMaterial is a simple material in terms of rendering that perform lookups on a 2d map blended optionally with the per vertex color input

Kuesa::IroMatteAlphaProperties

Kuesa::IroMatteAlphaProperties holds the properties controlling the visual appearance of a IroMatteAlphaMaterial instance

Kuesa::IroMatteBackgroundEffect

Kuesa::IroMatteBackgroundEffect is the effect for the IroMatteBackgroundMaterial class

Kuesa::IroMatteBackgroundMaterial

Kuesa::IroMatteBackgroundMaterial is a simple material in terms of rendering that allows to render an arbitrary meshes as a background by projecting the vertices in screen space

Kuesa::IroMatteBackgroundProperties

Kuesa::IroMatteBackgroundProperties holds the properties controlling the visual appearance of a IroMatteBackgroundMaterial instance

Kuesa::IroMatteMultEffect

Kuesa::IroMatteMultEffect is the effect for the IroMatteMultMaterial class

Kuesa::IroMatteMultMaterial

Kuesa::IroMatteMultMaterial is a simple material in terms of rendering that perform lookups on a 2d map optionally blended with the per vertex color input and perform multiplicative color blending

Kuesa::IroMatteMultProperties

Kuesa::IroMatteMultProperties holds the properties controlling the visual appearance of a IroMatteMultMaterial instance

Kuesa::IroMatteOpaqueEffect

Kuesa::IroMatteOpaqueEffect is the effect for the IroMatteOpaqueMaterial class

Kuesa::IroMatteOpaqueMaterial

Kuesa::IroMatteOpaqueMaterial is a simple material in terms of rendering that perform lookups on a 2d map blended optionally with the per vertex color input

Kuesa::IroMatteOpaqueProperties

Kuesa::IroMatteOpaqueProperties holds the properties controlling the visual appearance of a IroMatteOpaqueMaterial instance

Kuesa::IroMatteSkyboxEffect

Kuesa::IroMatteSkyboxEffect is the effect for the IroMatteSkyboxMaterial class

Kuesa::IroMatteSkyboxMaterial

Kuesa::IroMatteSkyboxMaterial is a simple material in terms of rendering that allows to render a skybox for arbitrary meshes by translating the vertices to the eye position

Kuesa::IroMatteSkyboxProperties

Kuesa::IroMatteSkyboxProperties holds the properties controlling the visual appearance of a IroMatteSkyboxMaterial instance

Kuesa::KTXTexture

Texture subclass that handles loading ktx files (both KTX1 and KTX2)

Kuesa::KuesaNode

Base class for nodes that require a Kuesa::SceneEnity for assets * insertion or retrieval. * * The KuesaNode class is a convenience wrapper that handles setting a * SceneEntity property on a node. It also automatically traverse the QObject * tree hierarchy to find if a Kuesa::SceneEntity is part of the hierarchy. If * so and if no Kuesa::SceneEntity was provided by the user, it will set the * sceneEntity property to that

Kuesa::LayerCollection

A collection of assets of type Qt3DRender::QLayer

Kuesa::LightCollection

A collection of assets of type Qt3DRender::QAbstractLight

Kuesa::MaterialCollection

A collection of assets of type GLTF2MaterialProperties

Kuesa::MeshCollection

A collection of assets of type QGeometryRenderer

Kuesa::MeshInstantiator

Kuesa::MeshInstantiator allows to render several instances of a same mesh with different transformations

Kuesa::MetallicRoughnessEffect

Kuesa::MetallicRoughnessEffect is a Qt3DRender::QEffect for Kuesa::MetallicRoughnessMaterial. It provides several properties used to configure the material effect. This is done using a custom shader graph and activating/deactivating different set of nodes of the graph depending on the effect configuration

Kuesa::MetallicRoughnessMaterial

Kuesa::MetallicRoughnessMaterial is a ready to use physically based rendering (PBR) material based on the glTF 2.0 material description

Kuesa::MetallicRoughnessProperties

Kuesa::MetallicRoughnessProperties hold the properties of a physically based rendering (PBR) material based on the glTF 2.0 material description

Kuesa::MorphController

Kuesa::MorphController allows to control the morph target weights of an entity. Though the glTF 2.0 specifications do not impose a limit on the number of weights, we have limited it to 8

Kuesa::OpacityMask

Masks onscreen content based on the alpha color value of a mask texture

Kuesa::Particles

Particle system that controls emission and the various properties or particles over their lifetime

Kuesa::Placeholder

Specifies a placeholder which can be used to anchor QtQuick elements

Kuesa::PlaceholderCollection

A collection of assets of type Kuesa::Placeholder

Kuesa::PlaceholderTracker

Allows watching a placeholder for changes and computing a screen position changes given a window size and a camera

Kuesa::ReflectionPlane

Specifies a reflection plane for a View of the scene

Kuesa::ReflectionPlaneCollection

A collection of assets of type Kuesa::ReflectionPlane

Kuesa::SceneEntity

Root entity for Kuesa runtime

Kuesa::ShadowCastingLight

Encapsulate a light object that is able to cast shadows in a Qt 3D scene

Kuesa::SkeletonCollection

A collection of assets of type Qt3DCore::QAbstractSkeleton

Kuesa::Skybox

Kuesa::SkyBox is a convenience Qt3DCore::QEntity subclass used to insert a skybox in a 3D scene. Unlike Qt3DExtras::SkyboxEntity, its implementation is compatible with the Kuesa provided default framegraph

Kuesa::SpotLight

Encapsulate a Spot Light object in a Qt 3D scene

Kuesa::TextureCollection

A collection of assets of type Qt3DRender::QAbstractTexture

Kuesa::TextureImageCollection

A collection of assets of type Qt3DRender::QAbstractTextureImage

Kuesa::TextureTransform

Kuesa::TextureTransform provides an easy to use texture transform implementation. Given an offset, a rotation and a scale, it produces a matrix that can be directly pushed to a shader and used to transform uv coordinates

Kuesa::ThresholdEffect

Post-processing effect showing only pixels brighter than a specified value

Kuesa::ToneMappingAndGammaCorrectionEffect

Perform conversion from linear color space to sRGB space

Kuesa::TransformCollection

A collection of assets of type Qt3DCore::QTransform

Kuesa::TransformTracker

Allows watching a transform for change and computing a projected screen position given a window size and a camera

Kuesa::UnlitEffect

Kuesa::UnlitEffect is a Qt3DRender::QEffect for Kuesa::UnlitMaterial. It provides several properties used to configure the material effect. This is done using a custom shader graph and activating/deactivating different set of nodes of the graph depending on the effect configuration

Kuesa::UnlitMaterial

Kuesa::UnlitMaterial is a simple material without shading. It implements the KHR_materials_unlit extension from glTF 2.0

Kuesa::UnlitProperties

Kuesa::UnlitProperties hold the properties of a simple material without shading. It implements the KHR_materials_unlit extension from glTF 2.0

Kuesa::View

Allows to specify the rendering description for a rendered view of the scene. They are to be used along with the QForwardRenderer FrameGraph

KuesaUtils::SceneConfiguration

Way of conveniently specifying information about a glTF2 file and accompanying helpers to be loaded

KuesaUtils::View3DScene

Convenience wrapper aiming at simplifying the set up of a 3D scene and the loading of a glTF 2 scene file