Navigation
API > API/Runtime > API/Runtime/Engine
Material expression for sampling from a runtime virtual texture.
| Name | UMaterialExpressionRuntimeVirtualTextureSample |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
| Include Path | #include "Materials/MaterialExpressionRuntimeVirtualTextureSample.h" |
Syntax
UCLASS (CollapseCategories, HideCategories=Object, MinimalAPI)
class UMaterialExpressionRuntimeVirtualTextureSample : public UMaterialExpression
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMaterialExpression → UMaterialExpressionRuntimeVirtualTextureSample
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMaterialExpressionRuntimeVirtualTextureSample
(
const FObjectInitializer& ObjectInitializer |
Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAdaptive | bool | Enable sparse adaptive page tables. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| bEnableFeedback | bool | Enable virtual texture feedback. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| bSinglePhysicalSpace | bool | Enable page table channel packing. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| Coordinates | FExpressionInput | Optional UV coordinates input if we want to override standard world position based coordinates. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| DDX | FExpressionInput | Derivative over the X axis. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| DDY | FExpressionInput | Derivative over the Y axis. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| MaterialType | ERuntimeVirtualTextureMaterialType | How to interpret the virtual texture contents. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| MipValue | FExpressionInput | Meaning depends on MipValueMode. A single unit is one mip level. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| MipValueMode | TEnumAsByte< enum ERuntimeVirtualTextureMipValueMode > | Defines how the mip level is calculated for the virtual texture lookup. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| TextureAddressMode | TEnumAsByte< enum ERuntimeVirtualTextureTextureAddressMode > | Defines the texture addressing mode. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| VirtualTexture | TObjectPtr< class URuntimeVirtualTexture > | The virtual texture object to sample. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| WorldPosition | FExpressionInput | Optional world position input to override the default world position. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
| WorldPositionOriginType | EPositionOrigin | Defines the reference space for the WorldPosition input. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ESamplerSourceMode GetSamplerSourceMode() |
Returns the sampler source mode for the respective TextureAddressMode value. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
bool InitVirtualTextureDependentSettings() |
Init settings that affect shader compilation and need to match the current VirtualTexture | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetRVTUnpackProperties
(
int32 OutputIndex, |
Materials/MaterialExpressionRuntimeVirtualTextureSample.h | ||
void InitOutputs() |
Initialize the output pins. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
bool IsParameter() |
Returns true if this is a valid UMaterialExpressionRuntimeVirtualTextureSampleParameter. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
bool ValidateVirtualTextureParameters
(
FString& OutError |
Returns true if this material expression has a valid virtual texture object that matches the parameters of this expression. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
Overridden from UMaterialExpression
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Build
(
MIR::FEmitter& Emitter |
Builds this expression's material IR. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
virtual bool CanReferenceTexture() |
Returns true if GetReferencedTexture() / GetReferencedTextures() can ever return a valid pointer(s). | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
virtual int32 Compile
(
FMaterialCompiler* Compiler, |
Create the new shader code chunk needed for the Abs expression | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
| Returns the text to display on the material expression (in the material editor). | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | ||
virtual FExpressionInput * GetInput
(
int32 InputIndex |
Returns the input at index InputIndex if valid, nullptr otherwise. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h | |
virtual FName GetInputName
(
int32 InputIndex |
Materials/MaterialExpressionRuntimeVirtualTextureSample.h | ||
virtual UObject * GetReferencedTexture () |
To get any texture references this expression emits. | Materials/MaterialExpressionRuntimeVirtualTextureSample.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
Materials/MaterialExpressionRuntimeVirtualTextureSample.h | ||
virtual void PostLoad() |
Materials/MaterialExpressionRuntimeVirtualTextureSample.h |