1. Epic GamesDeveloper
  3. FTexture2DBuilder

FTexture2DBuilder

Texture2DBuilder is a utility class for creating/modifying various types of UTexture2D.

API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/AssetUtils

References

   
Module ModelingComponents
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/AssetUtils/Texture2DBuilder.h
Include #include "AssetUtils/Texture2DBuilder.h"

Syntax

class FTexture2DBuilder

Remarks

Texture2DBuilder is a utility class for creating/modifying various types of UTexture2D. Use Initialize() functions to configure, can either generate a new UTexture2D (in the Transient package) or modify an existing UTexture2D.

Currently the generated UTexture2D will only have Mip 0, and only Mip 0 can be edited. The generated UTexture2D has format PF_B8G8R8A8 or PF_FloatRGBA.

Use Commit() to lock and update the texture after editing is complete. LockForEditing() can be used to re-open. By default textures are locked for editing on Initialize()

If you have generated a UTexture2D by other means, you can use the static function CopyPlatformDataToSourceData() to populate the Source data from the PlatformData, which is required to save it as a UAsset.

Variables

  Type Name Description
Protected variable ETextureType BuildType  
Protected variable FColor * CurrentMipData  
Protected variable FFloat16Color * CurrentMipDataFloat16  
Protected variable EPixelFormat CurrentPixelFormat  
Protected variable FImageDimensions Dimensions  
Protected variable UTexture2D * RawTexture2D  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static UTexture2D *

BuildTextureFromImage ( const TImageBuilder< PixelType >& SourceImage,
FTexture2DBuilder::ETextureType TextureType,
const bool bConvertToSRGB,
bool bPopulateSourceData
)

 Create a new UTexture2D of the given TextureType from the given SourceImage
Public function void

Cancel ()

 Cancel active editing and unlock the texture data
Public function void

Clear ( const FFloat16Color& ClearColor
)

 Clear all texels in the current Mip to the given ClearColor
Public function void

Clear ( const FColor& ClearColor
)

 Clear all texels in the current Mip to the given ClearColor
Public function void

Clear ()

 Clear all texels in the current Mip to the clear/default color for the texture build type
Public function void

Commit ( bool bUpdateSourceData
)

 Unlock the Mip 0 buffer and update the texture rendering data.
Public function bool

Copy ( const TImageBuilder< FVector4f >& SourceImage,
const bool bConvertToSRGB
)

 Populate texel values from floating-point SourceImage.
Public function bool

Copy ( const TImageBuilder< FVector3f >& SourceImage,
const bool bConvertToSRGB
)

 Populate texel values from floating-point SourceImage
Public function bool

CopyImageToSourceData ( const TImageBuilder< FVector4f >& SourceImage,
const ETextureSourceFormat SourceDataFormat,
const bool bConvertToSRGB
)

 Populate Source Data texel values from a floating point SourceImage
Public function Static bool

CopyPlatformDataToSourceData ( UTexture2D* Texture,
ETextureType TextureType
)

 Use a FTexture2DBuilder to copy the PlatformData to the UTexture2D Source data, so it can be saved as an Asset
Public function void

CopyTexel ( int64 FromLinearIndex,
int64 ToLinearIndex
)

 Copy texel value from one linear index to another
Public function Const bool

CopyTo ( TImageBuilder< FVector4f >& DestImage
)

 Copy existing texel values to floating-point DestImage.
Public function Const const FColor &  
Public function Const FFloat16Color  
Public function Const const FImageDimensions &  
Public function Const const void * This point is invalid after the texture is Committed!
Public function void * This point is invalid after the texture is Committed!
Public function Const const FColor &

GetTexel ( const FVector2i& ImageCoords
)

 Get the FColor texel at the given X/Y coordinates
Public function Const const FColor &

GetTexel ( int64 LinearIndex
)

 Get the FColor texel at the given linear index
Public function Const const FFloat16Color &

GetTexelFloat16 ( const FVector2i& ImageCoords
)

 Get the FFloat16Color texel at the given X/Y coordinates
Public function Const const FFloat16Color &

GetTexelFloat16 ( int64 LinearIndex
)

 Get the FFloat16Color texel at the given linear index
Public function Const UTexture2D *  
Public function Const const EPixelFormat  
Public function Const const ETextureType  
Public function bool

Initialize ( ETextureType BuildTypeIn,
FImageDimensions DimensionsIn
)

 Create a new UTexture2D configured with the given BuildType and Dimensions
Public function bool

Initialize ( UTexture2D* ExistingTexture,
ETextureType BuildTypeIn,
bool bLockForEditing
)

 Initialize the builder with an existing UTexture2D
Public function bool

InitializeAndReplaceExistingTexture ( UTexture2D* ExistingTexture,
ETextureType BuildTypeIn,
FImageDimensions DimensionsIn
)

 Create a new UTexture2D 'over' an existing UTexture2D, with the given BuildType and Dimensions
Public function bool

InitializeAndReplaceExistingTexture ( UTexture2D* ExistingTexture,
UTexture2D* SourceTexture
)

 Create a new UTexture2D 'over' an existing UTexture2D using the same texture settings as a given source UTexture2D.
Public function Const const bool  
Public function Const bool  
Public function Const const bool  
Public function bool Lock the Mip 0 buffer for editing
Public function void

SetTexel ( int64 LinearIndex,
const FColor& NewValue
)

 Set the texel at the given linear index to the given FColor
Public function void

SetTexel ( int64 LinearIndex,
const FFloat16Color& NewValue
)

 Set the texel at the given linear index to the given FFloat16Color
Public function void

SetTexel ( const FVector2i& ImageCoords,
const FFloat16Color& NewValue
)

 Set the texel at the given X/Y coordinates to the given FFloat16Color
Public function void

SetTexel ( const FVector2i& ImageCoords,
const FColor& NewValue
)

 Set the texel at the given X/Y coordinates to the given FColor
Public function void Copy the current PlatformData to the UTexture2D Source Data.

Enums

  Type Name Description
Public enum ETextureType Supported texture types.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page