UMaterialExpressionRuntimeVirtualTextureSample

Material expression for sampling from a runtime virtual texture.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Materials/MaterialExpressionRuntimeVirtualTextureSample.h

Include

#include "Materials/MaterialExpressionRuntimeVirtualTextureSample.h"

Syntax

class UMaterialExpressionRuntimeVirtualTextureSample : public UMaterialExpression

Remarks

Material expression for sampling from a runtime virtual texture.

Variables

Name Description

Public variable

bool

 

bSinglePhysicalSpace

Enable page table channel packing.

Public variable

FExpressionInpu ...

 

Coordinates

Optional UV coordinates input if we want to override standard world position based coordinates.

Public variable

ERuntimeVirtual ...

 

MaterialType

How to interpret the virtual texture contents.

Public variable

FExpressionInpu ...

 

MipValue

Meaning depends on MipValueMode. A single unit is one mip level.

Public variable

TEnumAsByte < en...

 

MipValueMode

Defines how the MipValue property is applied to the virtual texture lookup.

Public variable

URuntimeVirtual ...

 

VirtualTexture

The virtual texture object to sample.

Public variable

FExpressionInpu ...

 

WorldPosition

Optional world position input to override the default world position.

Constructors

Name Description

Public function

UMaterialExpressionRuntimeVirtualTextureSample

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Protected function

void

 

InitOutputs()

Initialize the output pins.

Public function

bool

 

InitVirtualTextureDependentSettings()

Init settings that affect shader compilation and need to match the current VirtualTexture

Overridden from UMaterialExpression

Name Description

Protected function Virtual Const

bool

 

CanReferenceTexture()

Returns true if GetReferencedTexture() can ever return a valid pointer.

Protected function Virtual

int32

 

Compile

(
    FMaterialCompiler * Compiler,
    int32 OutputIndex
)

Create the new shader code chunk needed for the Abs expression

Protected function Virtual Const

void

 

GetCaption

(
    TArray < FString >& OutCaptions
)

Returns the text to display on the material expression (in the material editor).

Protected function Virtual Const

UObject *...

 

GetReferencedTexture()

Callback to get any texture reference this expression emits.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback