UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TShaderRefBase< ShaderType, PointerTableType > Class Template Reference

#include <Shader.h>

+ Inheritance diagram for TShaderRefBase< ShaderType, PointerTableType >:

Public Member Functions

 TShaderRefBase ()
 
 TShaderRefBase (ShaderType *InShader, const FShaderMapBase &InShaderMap)
 
 TShaderRefBase (const TShaderRefBase &)=default
 
template<typename OtherShaderType , typename OtherPointerTableType >
 TShaderRefBase (const TShaderRefBase< OtherShaderType, OtherPointerTableType > &Rhs)
 
TShaderRefBaseoperator= (const TShaderRefBase &)=default
 
template<typename OtherShaderType , typename OtherPointerTableType >
TShaderRefBaseoperator= (const TShaderRefBase< OtherShaderType, OtherPointerTableType > &Rhs)
 
bool IsValid () const
 
bool IsNull () const
 
void Reset ()
 
ShaderType * GetShader () const
 
const FShaderMapBaseGetShaderMap () const
 
const FShaderMapBaseGetShaderMapChecked () const
 
FShaderTypeGetType () const
 
FVertexFactoryTypeGetVertexFactoryType () const
 
FShaderMapResourceGetResourceChecked () const
 
const PointerTableTypeGetPointerTable () const
 
FShaderMapResourceGetResource () const
 
ShaderType * operator-> () const
 
FRHIShaderGetRHIShaderBase (EShaderFrequency Frequency, bool bRequired=true) const
 
FRHIGraphicsShaderGetGraphicsShader (bool bRequired=true) const
 
FRHIVertexShaderGetVertexShader (bool bRequired=true) const
 
FRHIMeshShaderGetMeshShader () const
 
FRHIAmplificationShaderGetAmplificationShader () const
 
FRHIPixelShaderGetPixelShader (bool bRequired=true) const
 
FRHIGeometryShaderGetGeometryShader () const
 
FRHIComputeShaderGetComputeShader () const
 
FRHIWorkGraphShaderGetWorkGraphShader () const
 

Static Public Member Functions

template<typename OtherShaderType , typename OtherPointerTableType >
static TShaderRefBase< ShaderType, PointerTableTypeCast (const TShaderRefBase< OtherShaderType, OtherPointerTableType > &Rhs)
 
template<typename OtherShaderType , typename OtherPointerTableType >
static TShaderRefBase< ShaderType, PointerTableTypeReinterpretCast (const TShaderRefBase< OtherShaderType, OtherPointerTableType > &Rhs)
 

Friends

template<typename ShaderType1 >
bool operator== (const TShaderRefBase &Lhs, const TShaderRefBase< ShaderType1, PointerTableType > &Rhs)
 
template<typename ShaderType1 >
bool operator!= (const TShaderRefBase &Lhs, const TShaderRefBase< ShaderType1, PointerTableType > &Rhs)
 

Constructor & Destructor Documentation

◆ TShaderRefBase() [1/4]

template<typename ShaderType , typename PointerTableType >
TShaderRefBase< ShaderType, PointerTableType >::TShaderRefBase ( )
inline

◆ TShaderRefBase() [2/4]

template<typename ShaderType , typename PointerTableType >
TShaderRefBase< ShaderType, PointerTableType >::TShaderRefBase ( ShaderType *  InShader,
const FShaderMapBase InShaderMap 
)
inline

◆ TShaderRefBase() [3/4]

template<typename ShaderType , typename PointerTableType >
TShaderRefBase< ShaderType, PointerTableType >::TShaderRefBase ( const TShaderRefBase< ShaderType, PointerTableType > &  )
default

◆ TShaderRefBase() [4/4]

Member Function Documentation

◆ Cast()

◆ GetAmplificationShader()

template<typename ShaderType , typename PointerTableType >
FRHIAmplificationShader * TShaderRefBase< ShaderType, PointerTableType >::GetAmplificationShader ( ) const
inline
Returns
the shader's aplification shader

◆ GetComputeShader()

template<typename ShaderType , typename PointerTableType >
FRHIComputeShader * TShaderRefBase< ShaderType, PointerTableType >::GetComputeShader ( ) const
inline
Returns
the shader's compute shader

◆ GetGeometryShader()

template<typename ShaderType , typename PointerTableType >
FRHIGeometryShader * TShaderRefBase< ShaderType, PointerTableType >::GetGeometryShader ( ) const
inline
Returns
the shader's geometry shader

◆ GetGraphicsShader()

template<typename ShaderType , typename PointerTableType >
FRHIGraphicsShader * TShaderRefBase< ShaderType, PointerTableType >::GetGraphicsShader ( bool  bRequired = true) const
inline

◆ GetMeshShader()

template<typename ShaderType , typename PointerTableType >
FRHIMeshShader * TShaderRefBase< ShaderType, PointerTableType >::GetMeshShader ( ) const
inline
Returns
the shader's mesh shader

◆ GetPixelShader()

template<typename ShaderType , typename PointerTableType >
FRHIPixelShader * TShaderRefBase< ShaderType, PointerTableType >::GetPixelShader ( bool  bRequired = true) const
inline
Returns
the shader's pixel shader

◆ GetPointerTable()

template<typename ShaderType , typename PointerTableType >
const PointerTableType & TShaderRefBase< ShaderType, PointerTableType >::GetPointerTable ( ) const
inline

◆ GetResource()

template<typename ShaderType , typename PointerTableType >
FShaderMapResource * TShaderRefBase< ShaderType, PointerTableType >::GetResource ( ) const
inline

◆ GetResourceChecked()

template<typename ShaderType , typename PointerTableType >
FShaderMapResource & TShaderRefBase< ShaderType, PointerTableType >::GetResourceChecked ( ) const
inline

◆ GetRHIShaderBase()

template<typename ShaderType , typename PointerTableType >
FRHIShader * TShaderRefBase< ShaderType, PointerTableType >::GetRHIShaderBase ( EShaderFrequency  Frequency,
bool  bRequired = true 
) const
inline

◆ GetShader()

template<typename ShaderType , typename PointerTableType >
ShaderType * TShaderRefBase< ShaderType, PointerTableType >::GetShader ( ) const
inline

◆ GetShaderMap()

template<typename ShaderType , typename PointerTableType >
const FShaderMapBase * TShaderRefBase< ShaderType, PointerTableType >::GetShaderMap ( ) const
inline

◆ GetShaderMapChecked()

template<typename ShaderType , typename PointerTableType >
const FShaderMapBase & TShaderRefBase< ShaderType, PointerTableType >::GetShaderMapChecked ( ) const
inline

◆ GetType()

template<typename ShaderType , typename PointerTableType >
FShaderType * TShaderRefBase< ShaderType, PointerTableType >::GetType ( ) const
inline

◆ GetVertexFactoryType()

template<typename ShaderType , typename PointerTableType >
FVertexFactoryType * TShaderRefBase< ShaderType, PointerTableType >::GetVertexFactoryType ( ) const
inline

◆ GetVertexShader()

template<typename ShaderType , typename PointerTableType >
FRHIVertexShader * TShaderRefBase< ShaderType, PointerTableType >::GetVertexShader ( bool  bRequired = true) const
inline
Returns
the shader's vertex shader

◆ GetWorkGraphShader()

template<typename ShaderType , typename PointerTableType >
FRHIWorkGraphShader * TShaderRefBase< ShaderType, PointerTableType >::GetWorkGraphShader ( ) const
inline
Returns
the shader's work graph shader

◆ IsNull()

template<typename ShaderType , typename PointerTableType >
bool TShaderRefBase< ShaderType, PointerTableType >::IsNull ( ) const
inline

◆ IsValid()

template<typename ShaderType , typename PointerTableType >
bool TShaderRefBase< ShaderType, PointerTableType >::IsValid ( ) const
inline

◆ operator->()

template<typename ShaderType , typename PointerTableType >
ShaderType * TShaderRefBase< ShaderType, PointerTableType >::operator-> ( ) const
inline

◆ operator=() [1/2]

template<typename ShaderType , typename PointerTableType >
TShaderRefBase & TShaderRefBase< ShaderType, PointerTableType >::operator= ( const TShaderRefBase< ShaderType, PointerTableType > &  )
default

◆ operator=() [2/2]

◆ ReinterpretCast()

template<typename ShaderType , typename PointerTableType >
static TShaderRefBase< ShaderType, PointerTableType > TShaderRefBase< ShaderType, PointerTableType >::ReinterpretCast ( const TShaderRefBase< OtherShaderType, OtherPointerTableType > &  Rhs)
inlinestatic

◆ Reset()

template<typename ShaderType , typename PointerTableType >
void TShaderRefBase< ShaderType, PointerTableType >::Reset ( )
inline

Friends And Related Symbol Documentation

◆ operator!=

template<typename ShaderType , typename PointerTableType >
template<typename ShaderType1 >
bool operator!= ( const TShaderRefBase< ShaderType, PointerTableType > &  Lhs,
const TShaderRefBase< ShaderType1, PointerTableType > &  Rhs 
)
friend

◆ operator==

template<typename ShaderType , typename PointerTableType >
template<typename ShaderType1 >
bool operator== ( const TShaderRefBase< ShaderType, PointerTableType > &  Lhs,
const TShaderRefBase< ShaderType1, PointerTableType > &  Rhs 
)
friend

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