1. Epic GamesDeveloper
  3. FRenderGridUtils

FRenderGridUtils

A class containing static utility functions for the RenderGrid module.

API > API/Plugins > API/Plugins/RenderGrid > API/Plugins/RenderGrid/Utils

References

   
Module RenderGrid
Header /Engine/Plugins/Experimental/RenderGrid/Source/RenderGrid/Public/Utils/RenderGridUtils.h
Include #include "Utils/RenderGridUtils.h"

Syntax

class FRenderGridUtils

Remarks

A class containing static utility functions for the RenderGrid module.

Functions

  Type Name Description
Public function Static UTexture2D *

BytesToExistingImage ( const TArray< uint8 >& ByteArray,
const EImageFormat ImageFormat,
UTexture2D* Texture2D,
bool& bOutReusedGivenTexture2D
)

 Converts bytes into an texture.
Public function Static UTexture2D *

BytesToImage ( const TArray< uint8 >& ByteArray,
const EImageFormat ImageFormat
)

 Converts bytes into a texture.Returns NULL if it fails.
Public function Static UTexture2D *

DataToExistingTexture2D ( int32 Width,
int32 Height,
const void* Src,
SIZE_T Count,
UTexture2D* Texture2D,
bool& bOutReusedGivenTexture2D
)

 Converts texture data into an texture.
Public function Static UTexture2D *

DataToTexture2D ( int32 Width,
int32 Height,
const void* Src,
SIZE_T Count
)

 Converts texture data into a texture.Returns NULL if it fails.
Public function Static void

DeleteDirectory ( const FString& Directory
)

 Deletes all files and directories in the given directory, including the given directory.
Public function Static FString

DenormalizeJobOutputDirectory ( const FString& NormalizedOutputDirectory
)

 Returns a job output directory that's a usable valid filesystem path.
Public function Static FRenderGridPreviousEngineFpsSettings Disables the current FPS limiting, returns the previous settings which allow you to revert back to the previous state.
Public function Static void

EmptyDirectory ( const FString& Directory
)

 Deletes all files and directories in the given directory, won't delete the given directory.
Public function Static TArray< uint8 >

GetFileData ( const FString& File
)

 Returns the data of the file, returns an empty byte array if the file doesn't exist.
Public function Static TArray< FString >

GetFiles ( const FString& Directory,
const bool bRecursive
)

 Returns the paths of the files that exist in the given directory path.
Public function Static UTexture2D *

GetImage ( const FString& ImagePath,
UTexture2D* Texture2D,
bool& bOutReusedGivenTexture2D
)

 Loads an image from the disk, tries to automatically figure out the correct image format.
Public function Static TArray< uint8 >

GetRemoteControlValueBytesFromJson ( const TArray< uint8 >& OldValueBytes,
const FString& NewValueJson
)

 Converts a clean JSON string to low-level FProperty binary data.
Public function Static FString

GetRemoteControlValueJsonFromBytes ( const TArray< uint8 >& ValueBytes,
const bool PrettyPrint
)

 Converts the low-level FProperty binary data to a clean JSON string.
Public function Static bool

IsImage ( const FString& ImagePath
)

 Returns true if the given file is likely a valid image.
Public function Static FString

NormalizeJobOutputDirectory ( const FString& NewOutputDirectory
)

 Returns a job output directory that's converted to a full path (if it's currently relative) and that also has the project directory path replaced by "{project_dir}" (if the given path contains that string).
Public function Static FString

NormalizeOutputDirectory ( const FString& OutputDirectory
)

 Returns a normalized directory path.
Public function Static TSharedPtr< FJsonValue >

ParseJson ( const FString& Json
)

 Parses the given JSON string and returns the FJsonValue.
Public function Static FString

PurgeJobId ( const FString& JobId
)

 Returns a job ID with all invalid characters removed from it.
Public function Static FString Returns a job ID with all invalid characters removed from it.
Public function Static FString Returns a job ID with all invalid characters removed from it.
Public function Static FString

PurgeJobName ( const FString& JobName
)

 Returns a job name with all invalid characters removed from it.
Public function Static void Reverts back to the previous (given) state.
Public function Static FString

ToJsonString ( const TSharedPtr< FJsonValue >& Value,
const bool PrettyPrint
)

 Converts the given FJsonValue to a string.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page