Kuesa Runtime

Kuesa QML Types

The Kuesa QML types are imported with

 import Kuesa 1.3

The Kuesa Effects QML types are imported with

 import Kuesa.Effects 1.3

The Kuesa Iro QML types are imported with

 import Kuesa.Iro 1.3

The Kuesa Utils QML types are imported with

 import Kuesa.Utils 1.3

QML Types

Kuesa

AnimationPlayer

Play animations defined in glTF files

Asset

To access names nodes loaded from a glTF 2 file in a SceneEntity

BloomEffect

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

CameraAsset

Convenience wrapper to retrieve an asset from the Kuesa::SceneEntity::cameraCollection

DepthOfFieldEffect

Post-processing effect implementation of a depth of field

DirectionalLight

Encapsulate a Directional Light object in a Qt 3D scene

ForwardRenderer

Implements a simple forward rendering FrameGraph

GLTF2Importer

Imports glTF 2 scenes into a Qt 3D Scene

GLTF2Material

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

GLTF2MaterialEffect

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

GLTF2Options

Different options to configure the glTF 2.0 importer

GaussianBlurEffect

Post-processing effect for blurring the scene

Iro2AlphaEquiRectEffect

Kuesa::Iro2AlphaEquiRectEffect is the effect for the Iro2AlphaEquiRectMaterial class

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

Iro2AlphaEquiRectProperties

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

Iro2AlphaSemEffect

Kuesa::Iro2AlphaSemEffect is the effect for the Iro2AlphaSemMaterial class

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

Iro2AlphaSemProperties

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

Iro2DiffuseEquiRectEffect

Kuesa::Iro2DiffuseEquiRectEffect is the effect for the Iro2DiffuseEquiRectMaterial class

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

Iro2DiffuseEquiRectProperties

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

Iro2DiffuseSemEffect

Kuesa::Iro2DiffuseSemEffect is the effect for the Iro2DiffuseSemMaterial class

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

Iro2DiffuseSemProperties

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

Iro2GlassEquiRectEffect

Kuesa::Iro2GlassEquiRectEffect is the effect for the Iro2GlassEquiRectMaterial class

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

Iro2GlassEquiRectProperties

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

Iro2GlassSemEffect

Kuesa::Iro2GlassSemEffect is the effect for the Iro2GlassSemMaterial class

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

Iro2GlassSemProperties

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

Iro2MatteAlphaEffect

Kuesa::Iro2MatteAlphaEffect is the effect for the Iro2MatteAlphaMaterial class

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

Iro2MatteAlphaProperties

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

Iro2PlanarReflectionEquiRectEffect

Kuesa::Iro2PlanarReflectionEquiRectEffect is the effect for the Iro2PlanarReflectionEquiRectMaterial class

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

Iro2PlanarReflectionEquiRectProperties

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

Iro2PlanarReflectionSemEffect

Kuesa::Iro2PlanarReflectionSemEffect is the effect for the Iro2PlanarReflectionSemMaterial class

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

Iro2PlanarReflectionSemProperties

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

IroDiffuseAlphaEffect

Kuesa::IroDiffuseAlphaEffect is the effect for the IroDiffuseAlphaMaterial class

IroDiffuseAlphaMaterial

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

IroDiffuseAlphaProperties

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

IroDiffuseEffect

Kuesa::IroDiffuseEffect is the effect for the IroDiffuseMaterial class

IroDiffuseHemiEffect

Kuesa::IroDiffuseHemiEffect is the effect for the IroDiffuseHemiMaterial class

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

IroDiffuseHemiProperties

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

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

IroDiffuseProperties

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

IroGlassAddEffect

Kuesa::IroGlassAddEffect is the effect for the IroGlassAddMaterial class

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

IroGlassAddProperties

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

IroMatteAddEffect

Kuesa::IroMatteAddEffect is the effect for the IroMatteAddMaterial class

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

IroMatteAddProperties

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

IroMatteAlphaEffect

Kuesa::IroMatteAlphaEffect is the effect for the IroMatteAlphaMaterial class

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

IroMatteAlphaProperties

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

IroMatteBackgroundEffect

Kuesa::IroMatteBackgroundEffect is the effect for the IroMatteBackgroundMaterial class

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

IroMatteBackgroundProperties

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

IroMatteMultEffect

Kuesa::IroMatteMultEffect is the effect for the IroMatteMultMaterial class

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

IroMatteMultProperties

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

IroMatteOpaqueEffect

Kuesa::IroMatteOpaqueEffect is the effect for the IroMatteOpaqueMaterial class

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

IroMatteOpaqueProperties

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

IroMatteSkyboxEffect

Kuesa::IroMatteSkyboxEffect is the effect for the IroMatteSkyboxMaterial class

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

IroMatteSkyboxProperties

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

KTXTexture

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

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. * *

LayerAsset

Convenience wrapper to retrieve an asset from the Kuesa::SceneEntity::layerCollection

MaterialAsset

Convenience wrapper to retrieve an asset from the Kuesa::SceneEntity::materialCollection

MeshInstantiator

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

MetallicRoughnessEffect

Kuesa.MetallicRoughnessEffect is a Qt3D.Render.Effect for Kuesa.MetallicRoughnessMaterial

MetallicRoughnessMaterial

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

MetallicRoughnessProperties

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

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

OpacityMask

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

Placeholder

Specifies a placeholder which can be used to anchor QtQuick elements

PlaceholderTracker

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

PointLight

Encapsulate a Point Light object in a Qt 3D scene

QuickSceneMaterial

Convenience wrapper that renders QtQuick content onto a Qt 3D texture set on a Kuesa Material as the diffuseMap property

ReflectionPlane

Specifies a reflection plane for a View of the scene

SceneEntity

Root entity for Kuesa runtime

ShadowCastingLight

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

Skybox

Kuesa.SkyBox is a convenience Qt3D.Core.Entity subclass used to insert a skybox in a 3D scene. Unlike SkyboxEntity from Qt3D.Extras, its implementation is compatible with the Kuesa provided default framegraph

SpotLight

Encapsulate a Spot Light object in a Qt 3D scene

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

ThresholdEffect

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

ToneMappingAndGammaCorrectionEffect

Perform conversion from linear color space to sRGB space

TransformTracker

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

UnlitEffect

Kuesa.UnlitEffect is a Qt3D.Render.Effect for Kuesa.UnlitMaterial

UnlitMaterial

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

UnlitProperties

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

View

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

View3D

Convenience wrapper around Scene3D and KuesaUtils::View3DScene

KuesaUtils

SceneConfiguration

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

View3DScene

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