IDatasmithCompositeTexture

Windows
MacOS
Linux

References

Module

DatasmithCore

Header

/Engine/Source/Runtime/Datasmith/DatasmithCore/Public/IDatasmithSceneElements.h

Include

#include "IDatasmithSceneElements.h"

Syntax

class IDatasmithCompositeTexture

Destructors

Functions

Name Description

Public function

void

 

AddMaskSurface

(
    const TCHAR* InMask,
    const FDatasmithTextureSampler InMa...
)

Adds a new layer mask from its filename

Public function

void

 

AddMaskSurface

(
    const FLinearColor& Color
)

Creates a new surface to be used as mask that will be used as layer inside this composite using a color in linear space.

Public function

void

 

AddMaskSurface

(
    const TSharedPtr< IDatasmithComposi...
)

Adds a new composite texture inside this composite used as layer mask

Public function

void

 

AddParamVal1

(
    ParamVal InParamVal
)

Add a new Value1 parameter

Public function

void

 

AddParamVal2

(
    ParamVal InParamVal
)

Add a new Value2 parameter

Public function

void

 

AddSurface

(
    const TSharedPtr< IDatasmithComposi...
)

Adds a new nested composite texture

Public function

void

 

AddSurface

(
    const FLinearColor& Color
)

Creates a new surface that will be used as layer inside this composite using a color in linear space.

Public function

void

 

AddSurface

(
    const TCHAR* Texture,
    FDatasmithTextureSampler TexUV
)

Creates a new surface that will be used as layer inside this composite using the texture filename and its uv element.

Public function

void

 

ClearSurface()

Purges all the surfaces that could be used as layers inside this composite.

Public function Const

const TCHAR ...

 

GetBaseColName()

Returns the string that identifies the color element

Public function Const

const TCHAR ...

 

GetBaseCompName()

Returns the string that identifies the composite element

Public function Const

const TCHAR ...

 

GetBaseTextureName()

Returns the string that identifies the texture element

Public function Const

const TCHAR ...

 

GetBaseValName()

Returns the string that identifies the value element

Public function Const

bool

 

GetMaskUseComposite

(
    int32 i
)

Returns true if composite texture mask should be used

Public function Const

EDatasmithCo...

 

GetMode()

Gets the composition mode like color correction etc

Public function

const FLinea...

 

GetParamColor

(
    int32 i
)

Get the i-th color in linear space

Public function

const TCHAR ...

 

GetParamMask

(
    int32 i
)

Get the i-th layer mask's filename

Public function Const

const FLinea...

 

GetParamMaskColor

(
    int32 i
)

Get the i-th color in linear space

Public function

TSharedPtr< ...

 

GetParamMaskSubComposite

(
    int32 i
)

Get the ith composite texture inside this composite used as layer mask

Public function Const

int32

 

GetParamMaskSurfacesCount()

Get the amount of layer masks

Public function

FDatasmithTe...

 

GetParamMaskTextureSampler

(
    int32 i
)

Get the ith layer mask's uv element

Public function

TSharedPtr< ...

 

GetParamSubComposite

(
    int32 i
)

Get the i-th nested composite texture

Public function Const

int32

 

GetParamSurfacesCount()

Get the number of surfaces.

Public function

const TCHAR ...

 

GetParamTexture

(
    int32 i
)

Get the filename of the i-th texture

Public function

FDatasmithTe...

 

GetParamTextureSampler

(
    int32 i
)

Get the i-th uv element

Public function Const

ParamVal

 

GetParamVal1

(
    int32 i
)

Get the i-th Value1 parameter

Public function Const

int32

 

GetParamVal1Count()

Get the number of value1 parameters.

Public function Const

ParamVal

 

GetParamVal2

(
    int32 i
)

Get the Value2 parameter

Public function Const

int32

 

GetParamVal2Count()

Get the number of value2 parameters.

Public function

bool

 

GetUseColor

(
    int32 i
)

Gets color usage. If true color is used, else a value is used.

Public function

bool

 

GetUseComposite

(
    int32 i
)

Returns true if composite texture should be used

Public function

bool

 

GetUseTexture

(
    int32 i
)

Gets texture usage. If it returns false you should use a value or a color checking GetUseColor(i).

Public function Const

bool

 

IsValid()

Gets the validity of the composite texture.

Public function

void

 

SetBaseNames

(
    const TCHAR* InTextureName,
    const TCHAR* InColorName,
    const TCHAR* InValueName,
    const TCHAR* InCompName
)

Sets the strings that identifies the different elements on this composite

Public function

void

 

SetMode

(
    EDatasmithCompMode Mode
)

Sets the composition mode like color correction etc

Public function

void

 

SetParamTexture

(
    int32 InIndex,
    const TCHAR* InTexture
)

Sets the new texture for the index-th item

Typedefs

Name

Description

ParamVal

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss