Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QSSGRenderTextureProviderExtension Class Reference

\inmodule QtQuick3D More...

#include <qssgrenderextensions.h>

Inheritance diagram for QSSGRenderTextureProviderExtension:
Collaboration diagram for QSSGRenderTextureProviderExtension:

Public Member Functions

 QSSGRenderTextureProviderExtension ()
 ~QSSGRenderTextureProviderExtension () override
RenderMode mode () const final
RenderStage stage () const final
Public Member Functions inherited from QSSGRenderExtension
 QSSGRenderExtension ()
virtual ~QSSGRenderExtension ()
virtual bool prepareData (QSSGFrameData &data)=0
 Called after scene data is collected, but before any render data or rendering in the current frame has been done.
virtual void prepareRender (QSSGFrameData &data)=0
 Prepare data for rendering.
virtual void render (QSSGFrameData &data)=0
 Record the render pass.
virtual void resetForFrame ()=0
 Called each time a new frame starts.
Public Member Functions inherited from QSSGRenderGraphObject
bool hasGraphicsResources () const noexcept
virtual Q_QUICK3D_PROFILE_ID_ ~QSSGRenderGraphObject ()

Additional Inherited Members

Public Types inherited from QSSGRenderExtension
enum class  RenderMode { Standalone , Main }
 Specifies the render extension mode. More...
enum class  RenderStage { PreColor , PostColor }
 Specifies the order the extension will be called. More...
Public Types inherited from QSSGRenderGraphObject
enum  BaseType : quint32 {
  Node = 0x1000 , Light = 0x2000 , Camera = 0x4000 , Renderable = 0x8000 ,
  Resource = 0x10000 , Material = 0x20000 , Texture = 0x40000 , Extension = 0x80000 ,
  User = 0x80000000
}
enum class  Type : quint32 {
  Unknown = 0 , Node = BaseType::Node , Root , Layer ,
  Joint , Skeleton , ImportScene , ReflectionProbe ,
  DirectionalLight = BaseType::Light | BaseType::Node , PointLight , SpotLight , OrthographicCamera = BaseType::Camera | BaseType::Node ,
  PerspectiveCamera , CustomFrustumCamera , CustomCamera , Model = BaseType::Renderable | BaseType::Node ,
  Item2D , Particles , SceneEnvironment = BaseType::Resource , Effect ,
  Geometry , TextureData , MorphTarget , ModelInstance ,
  ModelBlendParticle , ResourceLoader , DefaultMaterial = BaseType::Material | BaseType::Resource , PrincipledMaterial ,
  CustomMaterial , SpecularGlossyMaterial , Skin , Image2D = BaseType::Texture | BaseType::Resource ,
  ImageCube , RenderExtension = BaseType::Extension , TextureProvider
}
enum class  Flags : quint32 { HasGraphicsResources = 0x1 }
using TypeT = std::underlying_type_t<Type>
using FlagT = std::underlying_type_t<Flags>
Static Public Member Functions inherited from QSSGRenderGraphObject
static constexpr bool isNodeType (Type type) noexcept
static constexpr bool isLight (Type type) noexcept
static constexpr bool isCamera (Type type) noexcept
static constexpr bool isMaterial (Type type) noexcept
static constexpr bool isTexture (Type type) noexcept
static constexpr bool isRenderable (Type type) noexcept
static constexpr bool isResource (Type type) noexcept
static constexpr bool isExtension (Type type) noexcept
static constexpr bool isUserType (Type type) noexcept
Public Attributes inherited from QSSGRenderGraphObject
const Type type
FlagT flags { 0 }
Protected Member Functions inherited from QSSGRenderExtension
 QSSGRenderExtension (Type inType, FlagT inFlags)
 Constructor that allows users to specifying a user-type and flags for an extension.
Protected Member Functions inherited from QSSGRenderGraphObject
 QSSGRenderGraphObject (QSSGRenderGraphObject::Type inType)
 QSSGRenderGraphObject (QSSGRenderGraphObject::Type inType, FlagT inFlags)

Detailed Description

\inmodule QtQuick3D

Since
6.11

Base class for texture providers backend node implementations.

Note
This class is meant to be used together with \l QQuick3DTextureProviderExtension. and the \l mode and \l stage is always Standalone and PostColor respectively.
See also
QQuick3DTextureProviderExtension

Definition at line 110 of file qssgrenderextensions.h.

Constructor & Destructor Documentation

◆ QSSGRenderTextureProviderExtension()

QSSGRenderTextureProviderExtension::QSSGRenderTextureProviderExtension ( )

Definition at line 301 of file qssgrenderextensions.cpp.

◆ ~QSSGRenderTextureProviderExtension()

QSSGRenderTextureProviderExtension::~QSSGRenderTextureProviderExtension ( )
override

Definition at line 307 of file qssgrenderextensions.cpp.

Member Function Documentation

◆ mode()

QSSGRenderExtension::RenderMode QSSGRenderTextureProviderExtension::mode ( ) const
finalvirtual
Returns
The render mode used for this extension.

Implements QSSGRenderExtension.

Definition at line 314 of file qssgrenderextensions.cpp.

◆ stage()

QSSGRenderExtension::RenderStage QSSGRenderTextureProviderExtension::stage ( ) const
finalvirtual
Returns
The stage in which this render extension will be used.

Implements QSSGRenderExtension.

Definition at line 312 of file qssgrenderextensions.cpp.

The documentation for this class was generated from the following files: