Qt Documentation

Qt 5.14
Qt 3D
Qt3DRender Namespace

Qt3DRender Namespace

Contains classes that enable 2D and 3D rendering. More...

Header:	#include <Qt3DRender>
qmake:	QT += 3drender

Namespaces

namespace	Quick
namespace	Render

Classes

class	QAbstractFunctor
class	QAbstractLight
class	QAbstractRayCaster
class	QAbstractTexture
class	QAbstractTextureImage
class	QAlphaCoverage
class	QAlphaTest
class	QAttribute
class	QBlendEquation
class	QBlendEquationArguments
class	QBlitFramebuffer
class	QBuffer
class	QBufferCapture
class	QBufferDataGenerator
class	QCamera
class	QCameraLens
class	QCameraSelector
class	QClearBuffers
class	QClipPlane
class	QColorMask
class	QComputeCommand
class	QCullFace
class	QDepthRange
class	QDepthTest
class	QDirectionalLight
class	QDispatchCompute
class	QDithering
class	QEffect
class	QEnvironmentLight
class	QFilterKey
class	QFrameGraphNode
class	QFrameGraphNodeCreatedChangeBase
class	QFrontFace
class	QFrustumCulling
class	QGeometry
class	QGeometryRenderer
class	QGraphicsApiFilter
class	QLayer
class	QLayerFilter
class	QLevelOfDetail
class	QLevelOfDetailBoundingSphere
class	QLevelOfDetailSwitch
class	QLineWidth
class	QMaterial
class	QMemoryBarrier
class	QMesh
class	QMultiSampleAntiAliasing
class	QNoDepthMask
class	QNoDraw
class	QNoPicking
class	QObjectPicker
class	QPaintedTextureImage
class	QParameter
class	QPickEvent
class	QPickLineEvent
class	QPickPointEvent
class	QPickTriangleEvent
class	QPickingSettings
class	QPointLight
class	QPointSize
class	QPolygonOffset
class	QProximityFilter
class	QRasterMode
class	QRayCaster
class	QRayCasterHit
class	QRenderAspect
class	QRenderCapture
class	QRenderCaptureReply
class	QRenderPass
class	QRenderPassFilter
class	QRenderSettings
class	QRenderState
class	QRenderStateSet
class	QRenderSurfaceSelector
class	QRenderTarget
class	QRenderTargetOutput
class	QRenderTargetSelector
class	QSceneLoader
class	QScissorTest
class	QScreenRayCaster
class	QSeamlessCubemap
class	QSetFence
class	QShaderData
class	QShaderImage
class	QShaderProgram
class	QShaderProgramBuilder
class	QSharedGLTexture
class	QSortPolicy
class	QSpotLight
class	QStencilMask
class	QStencilOperation
class	QStencilOperationArguments
class	QStencilTest
class	QStencilTestArguments
class	QSubtreeEnabler
class	QTechnique
class	QTechniqueFilter
class	QTexture1D
class	QTexture1DArray
class	QTexture2D
class	QTexture2DArray
class	QTexture2DMultisample
class	QTexture2DMultisampleArray
class	QTexture3D
class	QTextureBuffer
class	QTextureCubeMap
class	QTextureCubeMapArray
class	QTextureData
class	QTextureDataUpdate
class	QTextureGenerator
class	QTextureImage
class	QTextureImageData
class	QTextureImageDataGenerator
class	QTextureLoader
class	QTextureRectangle
class	QTextureWrapMode
class	QViewport
class	QWaitFence

Types

typedef	ParameterList
typedef	QBufferDataGeneratorPtr
typedef	QBufferPtr
typedef	QTextureImageDataPtr

Functions

qintptr	functorTypeId()
bool	operator!=(const Qt3DRender::QGraphicsApiFilter &reference, const Qt3DRender::QGraphicsApiFilter &sample)
bool	operator==(const Qt3DRender::QGraphicsApiFilter &reference, const Qt3DRender::QGraphicsApiFilter &sample)

Detailed Description

Namespaces

namespace Qt3DRender::Quick

namespace Qt3DRender::Render

Classes

class QAbstractFunctor

QAbstractFunctor is an abstract base class for all functors. More...

class QAbstractLight

Encapsulate a QAbstractLight object in a Qt 3D scene. More...

class QAbstractRayCaster

An abstract base class for ray casting in 3d scenes. More...

class QAbstractTexture

A base class to be used to provide textures. More...

class QAbstractTextureImage

Encapsulates the necessary information to create an OpenGL texture image. More...

class QAlphaCoverage

Enable alpha-to-coverage multisampling mode. More...

class QAlphaTest

The QAlphaTest class specify alpha reference test. More...

class QAttribute

Defines an attribute and how data should be read from a QBuffer. More...

class QBlendEquation

The QBlendEquation class specifies the equation used for both the RGB blend equation and the Alpha blend equation. More...

class QBlendEquationArguments

Encapsulates blending information: specifies how the incoming values (what's going to be drawn) are going to affect the existing values (what is already drawn). More...

class QBlitFramebuffer

FrameGraph node to transfer a rectangle of pixel values from one region of a render target to another. More...

class QBuffer

Provides a data store for raw data to later be used as vertices or uniforms. More...

class QBufferCapture

Exchanges buffer data between GPU and CPU. More...

class QBufferDataGenerator

Provides a mechanism to generate buffer data from a job. More...

class QCamera

The QCamera class defines a view point through which the scene will be rendered. More...

class QCameraLens

Qt3DRender::QCameraLens specifies the projection matrix that will be used to define a Camera for a 3D scene. More...

class QCameraSelector

Class to allow for selection of camera to be used. More...

class QClipPlane

Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance. More...

class QColorMask

Allows specifying which color components should be written to the currently bound frame buffer. More...

class QComputeCommand

QComponent to issue work for the compute shader on GPU. More...

class QCullFace

The QCullFace class specifies whether front or back face culling is enabled. More...

class QDepthRange

Enables remapping depth values written into the depth buffer. More...

class QDepthTest

The QDepthTest class tests the fragment shader's depth value against the depth of a sample being written to. More...

class QDirectionalLight

Encapsulate a Directional Light object in a Qt 3D scene. More...

class QDispatchCompute

FrameGraph node to issue work for the compute shader on GPU. More...

class QEffect

The base class for effects in a Qt 3D scene. More...

class QEnvironmentLight

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

class QFilterKey

The QFilterKey class provides storage for filter keys and their values. More...

class QFrameGraphNode

Base class of all FrameGraph configuration nodes. More...

class QFrameGraphNodeCreatedChangeBase

A base class for changes in the FrameGraphNode. More...

class QFrontFace

The QFrontFace class defines front and back facing polygons. More...

class QFrustumCulling

Enable frustum culling for the FrameGraph. More...

class QGeometryRenderer

Encapsulates geometry rendering. More...

class QGraphicsApiFilter

The QGraphicsApiFilter class identifies the API required for the attached QTechnique. More...

class QLayer

The QLayer class provides a way of filtering which entities will be rendered. More...

class QLayerFilter

Controls layers drawn in a frame graph branch. More...

class QLevelOfDetail

The QLevelOfDetail class provides a way of controlling the complexity of rendered entities based on their size on the screen. More...

class QLevelOfDetailBoundingSphere

The QLevelOfDetailBoundingSphere class provides a simple spherical volume, defined by its center and radius. More...

class QLevelOfDetailSwitch

Provides a way of enabling child entities based on distance or screen size. More...

class QLineWidth

Specifies the width of rasterized lines. More...

class QMaterial

Provides an abstract class that should be the base of all material component classes in a scene. More...

class QMemoryBarrier

Class to emplace a memory barrier. More...

class QMesh

A custom mesh loader. More...

class QMultiSampleAntiAliasing

Enable multisample antialiasing. More...

class QNoDraw

When a Qt3DRender::QNoDraw node is present in a FrameGraph branch, this prevents the renderer from rendering any primitive. More...

class QNoPicking

When a Qt3DRender::QNoPicking node is present in a FrameGraph branch, this prevents the render aspect from performing picking selection for the given branch. More...

class QObjectPicker

The QObjectPicker class instantiates a component that can be used to interact with a QEntity by a process known as picking. More...

class QPaintedTextureImage

A QAbstractTextureImage that can be written through a QPainter. More...

class QParameter

Provides storage for a name and value pair. This maps to a shader uniform. More...

class QPickEvent

The QPickEvent class holds information when an object is picked. More...

class QPickLineEvent

The QPickLineEvent class holds information when a segment of a line is picked. More...

class QPickPointEvent

The QPickPointEvent class holds information when a segment of a point cloud is picked. More...

class QPickTriangleEvent

The QPickTriangleEvent class holds information when a triangle is picked. More...

class QPickingSettings

The QPickingSettings class specifies how entity picking is handled. More...

class QPointLight

Encapsulate a Point Light object in a Qt 3D scene. More...

class QPointSize

Specifies the size of rasterized points. May either be set statically or by shader programs. More...

class QPolygonOffset

The QPolygonOffset class sets the scale and steps to calculate depth values for polygon offsets. More...

class QProximityFilter

Select entities which are within a distance threshold of a target entity. More...

class QRasterMode

The QRasterMode render state allows to control the type of rasterization to be performed. More...

class QRayCaster

Qt3DRender::QRayCaster is used to perform ray casting tests in 3d world coordinates. More...

class QRayCasterHit

Details of a hit when casting a ray through a model. More...

class QRenderCapture

Frame graph node for render capture. More...

class QRenderCaptureReply

Receives the result of render capture request. More...

class QRenderPassFilter

Provides storage for vectors of Filter Keys and Parameters. More...

class QRenderSettings

The QRenderSettings class holds settings related to rendering process and host the active FrameGraph. More...

class QRenderState

An abstract base class for all render states. More...

class QRenderStateSet

The QRenderStateSet FrameGraph node offers a way of specifying a set of QRenderState objects to be applied during the execution of a framegraph branch. More...

class QRenderSurfaceSelector

Provides a way of specifying the render surface. More...

class QRenderTarget

The QRenderTarget class encapsulates a target (usually a frame buffer object) which the renderer can render into. More...

class QRenderTargetOutput

The QRenderTargetOutput class allows the specification of an attachment of a render target (whether it is a color texture, a depth texture, etc... ). More...

class QRenderTargetSelector

Provides a way of specifying a render target. More...

class QSceneLoader

Provides the facility to load an existing Scene. More...

class QScissorTest

The QScissorTest class discards fragments that fall outside of a certain rectangular portion of the screen. More...

class QScreenRayCaster

Performe ray casting test based on screen coordinates. More...

class QSeamlessCubemap

Enables seamless cubemap texture filtering. More...

class QSetFence

FrameGraphNode used to insert a fence in the graphics command stream. More...

class QShaderData

Provides a way of specifying values of a Uniform Block or a shader structure. More...

class QShaderImage

Provides Image access to shader programs. More...

class QShaderProgramBuilder

Generates a Shader Program content from loaded graphs. More...

class QSharedGLTexture

Allows to use a textureId from a separate OpenGL context in a Qt 3D scene. More...

class QSortPolicy

Provides storage for the sort types to be used. More...

class QSpotLight

Encapsulate a Spot Light object in a Qt 3D scene. More...

class QStencilMask

The QStencilMask class controls the front and back writing of individual bits in the stencil planes. More...

class QStencilOperation

The QStencilOperation class specifies stencil operation. More...

class QStencilOperationArguments

The QStencilOperationArguments class sets the actions to be taken when stencil and depth tests fail. More...

class QStencilTest

The QStencilTest class specifies arguments for the stecil test. More...

class QStencilTestArguments

The QStencilTestArguments class specifies arguments for stencil test. More...

class QSubtreeEnabler

Enables or disables entire subtrees of framegraph nodes. More...

class QTechniqueFilter

A QFrameGraphNode used to select QTechniques to use. More...

class QTextureData

The QTextureData class stores texture information such as the target, height, width, depth, layers, wrap, and if mipmaps are enabled. More...

class QTextureDataUpdate

QTextureDataUpdate holds content and information required to perform partial updates of a texture content. More...

class QTextureGenerator

Provides the image data for a texture. More...

class QTextureImage

Encapsulates the necessary information to create an OpenGL texture image from an image source. More...

class QTextureImageData

QTextureImageData stores data representing a texture. More...

class QTextureImageDataGenerator

Provides texture image data for QAbstractTextureImage. More...

class QTextureLoader

Handles the texture loading and setting the texture's properties. More...

class QTextureRectangle

A QAbstractTexture with a TargetRectangle target format. More...

class QTextureWrapMode

Defines the wrap mode a Qt3DRender::QAbstractTexture should apply to a texture. More...

class QWaitFence

FrameGraphNode used to wait for a fence in the graphics command stream to become signaled. More...

Type Documentation

typedef ParameterList

A list of Qt3DRender::QParameter parameters.

typedef QBufferDataGeneratorPtr

typedef QBufferPtr

typedef QTextureImageDataPtr

Shared pointer to QTextureImageData.

Function Documentation

qintptr Qt3DRender::functorTypeId()

Returns a pointer to the type id of the functor.

bool operator!=(const Qt3DRender::QGraphicsApiFilter &reference, const Qt3DRender::QGraphicsApiFilter &sample)

Returns true if reference and sample are different.

bool operator==(const Qt3DRender::QGraphicsApiFilter &reference, const Qt3DRender::QGraphicsApiFilter &sample)

Returns true if reference and sample are equivalent.

© 2020 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.

Qt Documentation

Contents

Qt3DRender Namespace

Namespaces

Classes

Types

Functions

Detailed Description

Namespaces

namespace Qt3DRender::Quick

namespace Qt3DRender::Render

Classes

class QAbstractFunctor

class QAbstractLight

class QAbstractRayCaster

class QAbstractTexture

class QAbstractTextureImage

class QAlphaCoverage

class QAlphaTest

class QAttribute

class QBlendEquation

class QBlendEquationArguments

class QBlitFramebuffer

class QBuffer

class QBufferCapture

class QBufferDataGenerator

class QCamera

class QCameraLens

class QCameraSelector

class QClearBuffers

class QClipPlane

class QColorMask

class QComputeCommand

class QCullFace

class QDepthRange

class QDepthTest

class QDirectionalLight

class QDispatchCompute

class QDithering

class QEffect

class QEnvironmentLight

class QFilterKey

class QFrameGraphNode

class QFrameGraphNodeCreatedChangeBase

class QFrontFace

class QFrustumCulling

class QGeometry

class QGeometryRenderer

class QGraphicsApiFilter

class QLayer

class QLayerFilter

class QLevelOfDetail

class QLevelOfDetailBoundingSphere

class QLevelOfDetailSwitch

class QLineWidth

class QMaterial

class QMemoryBarrier

class QMesh

class QMultiSampleAntiAliasing

class QNoDepthMask

class QNoDraw

class QNoPicking

class QObjectPicker

class QPaintedTextureImage

class QParameter

class QPickEvent

class QPickLineEvent

class QPickPointEvent

class QPickTriangleEvent

class QPickingSettings

class QPointLight

class QPointSize

class QPolygonOffset

class QProximityFilter

class QRasterMode

class QRayCaster

class QRayCasterHit

class QRenderAspect

class QRenderCapture

class QRenderCaptureReply