Qt Quick 3D QML Types

This is the QML frontend for using the spatial renderer and scenegraph. For the time being, all 3D content goes through offscreen textures (FBO)s so that they can be composed into Qt Quick scenes (as a QQuickItem).

Qt Quick 3D provides the following QML types:

QtQuick3D QML Types

Import the QtQuick3D module with the following statement:

import QtQuick3D

Bounds

Specifies the bounds of a model

Buffer

Creates or references a color buffer to be used for a pass of an Effect

BufferInput

Defines an input buffer to be used as input for a pass of an Effect

Camera

Defines an abstract base for Cameras

Command

Supertype of commands to be performed as part of a pass in an Effect

CustomCamera

Defines a Camera with a custom projection matrix

CustomMaterial

Base component for creating custom materials used to shade models

DefaultMaterial

Lets you define a material for 3D items using the specular/glossiness workflow

DirectionalLight

Defines a directional light in the scene

Effect

Base component for creating a post-processing effect

FileInstancing

Allows reading instance tables from file

FrustumCamera

Defines a PerspectiveCamera with a custom frustum

Geometry

Base type for custom geometry

InstanceList

Allows manually specifying instancing in QML

InstanceListEntry

Specifies an instance in an InstanceList

Instancing

Base type for instance tables

Joint

Defines a node in a skeletal animation hierarchy

Light

An uncreatable abstract base type for all lights

Loader3D

Allows dynamic loading of a 3D subtree from a URL or Component

Material

Abstract base type providing functionality common to materials

Model

Lets you load a 3D model data

MorphTarget

Defines the properties of a morph target

Node

Base component for an object that exists in a 3D scene

Object3D

Abstract base type of all 3D nodes and resources

OrthographicCamera

Defines an Camera with an orthographic projection matrix

Pass

Defines a render pass in an Effect

PerspectiveCamera

Defines a Perspective Camera for viewing the content of a 3D scene

PickResult

Contains the results of a pick

PointLight

Defines a point light in the scene

PrincipledMaterial

Lets you define a material for 3D items using the metal/roughness workflow

QuaternionAnimation

A PropertyAnimation for quaternions

RenderStats

Provides information of the scene rendering

Repeater3D

Instantiates a number of Node-based components using a provided model

SceneEnvironment

Lets you configure how a scene is rendered

SetUniformValue

Defines a value to be set during a single pass

Shader

Container component for defining shader code used by post-processing effects

Skeleton

Defines a skeletal animation hierarchy

SpotLight

Defines a spot light in the scene

Texture

Defines a texture for use in 3D scenes

TextureData

Base type for custom texture data

TextureInput

Specifies a texture exposed to the shaders of a CustomMaterial or Effect

View3D

Provides a viewport on which to render a 3D scene

import QtQuick3D.Effects

AdditiveColorGradient

A gradient with additive color effect

Blur

A one-pass blur effect

BrushStrokes

A brush strokes noise effect

ChromaticAberration

A chromatic aberration effect

ColorMaster

A color adjustment effect

DepthOfFieldHQBlur

A depth-based blur effect

Desaturate

A desaturating effect

DistortionRipple

A ripple distortion effect

DistortionSphere

A sphere distortion effect

DistortionSpiral

A spiral distortion effect

EdgeDetect

An edge highlighting effect

Emboss

An emboss effect

Flip

A scene flipping effect

Fxaa

A fast approximate anti-aliasing effect

GaussianBlur

A two-pass gaussian blur effect

HDRBloomTonemap

A bloom with tonemapping effect

MotionBlur

A motion blur effect

SCurveTonemap

A tonemapping effect

Scatter

A scatter noise effect

TiltShift

A tilt shift blur effect

Vignette

A vignette effect

QtQuick3D.Helpers QML Types

Import the QtQuick3D.Helpers module with the following statement:

import QtQuick3D.Helpers

AxisHelper

Visual helper for showing the 3 axes and a grid in a 3D scene

DebugView

View to show render statistics

GridGeometry

A custom geometry provider for rendering grids

InstanceRange

Specifies a range for RandomInstancing

RandomInstancing

Generates a random instancing table

WasdController

Control node position and orientation with keys and mouse

QtQuick3D.AssetUtils QML Types

Import the QtQuick3D.AssetUtils module with the following statement:

import QtQuick3D.AssetUtils

RuntimeLoader

Imports a 3D asset at runtime

QtQuick3D.Particles3D QML Types

Import the QtQuick3D.Particles3D module with the following statement:

import QtQuick3D.Particles3D

Affector3D

Affectors modify the attributes of particles during their lifetime

Attractor3D

Attracts particles towards a position or a shape

Direction3D

Directions assign velocity for the emitted particles

EmitBurst3D

Declarative emitter bursts

Gravity3D

Accelerates particles to a vector of the specified magnitude in the specified direction

ModelBlendParticle3D

Blends particle effect with a 3D model

ModelParticle3D

Particle using a Qt Quick 3D Model

Particle3D

Abstract logical particle

ParticleAbstractShape3D

Abstract base type of particle shapes

ParticleEmitter3D

Emitter for logical particles

ParticleModelShape3D

Offers particle shape from model for emitters and affectors

ParticleShape3D

Offers 3D shapes for emitters and affectors

ParticleSystem3D

A system which includes particle, emitter, and affector types

ParticleSystem3DLogging

Provides information of the particle system

PointRotator3D

Rotates particles around a pivot point

SpriteParticle3D

Particle using a 2D sprite texture

SpriteSequence3D

Provides image sequence features for the Sprite particles

TargetDirection3D

For specifying a direction towards the target position

TrailEmitter3D

Emitter for logical particles from other particles

VectorDirection3D

For specifying a direction towards the target direction

Wander3D

Applies random wave curves to particles

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.