FRenderGridUtils | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/RenderGrid

A class containing static utility functions for the RenderGrid module.


Name	FRenderGridUtils
Type	class
Header File	/Engine/Plugins/Experimental/RenderGrid/Source/RenderGrid/Public/Utils/RenderGridUtils.h
Include Path	#include "Utils/RenderGridUtils.h"

Syntax

class FRenderGridUtils

Functions

Static

Name	Remarks	Include Path
static UTexture2D * BytesToExistingImage ( const TArray< uint8 >& ByteArray, const EImageFormat ImageFormat, UTexture2D* Texture2D, bool& bOutReusedGivenTexture2D )	Converts bytes into an texture.	Utils/RenderGridUtils.h
static UTexture2D * BytesToImage ( const TArray< uint8 >& ByteArray, const EImageFormat ImageFormat )	Converts bytes into a texture.Returns NULL if it fails.	Utils/RenderGridUtils.h
static UTexture2D * DataToExistingTexture2D ( int32 Width, int32 Height, const void* Src, SIZE_T Count, UTexture2D* Texture2D, bool& bOutReusedGivenTexture2D )	Converts texture data into an texture.	Utils/RenderGridUtils.h
static UTexture2D * DataToTexture2D ( int32 Width, int32 Height, const void* Src, SIZE_T Count )	Converts texture data into a texture.Returns NULL if it fails.	Utils/RenderGridUtils.h
static void DeleteDirectory ( const FString& Directory )	Deletes all files and directories in the given directory, including the given directory.	Utils/RenderGridUtils.h
static FString DenormalizeJobOutputDirectory ( const FString& NormalizedOutputDirectory )	Returns a job output directory that's a usable valid filesystem path.	Utils/RenderGridUtils.h
static FRenderGridPreviousEngineFpsSettings DisableFpsLimit()	Disables the current FPS limiting, returns the previous settings which allow you to revert back to the previous state.	Utils/RenderGridUtils.h
static void EmptyDirectory ( const FString& Directory )	Deletes all files and directories in the given directory, won't delete the given directory.	Utils/RenderGridUtils.h
static TArray< uint8 > GetFileData ( const FString& File )	Returns the data of the file, returns an empty byte array if the file doesn't exist.	Utils/RenderGridUtils.h
static TArray< FString > GetFiles ( const FString& Directory, const bool bRecursive )	Returns the paths of the files that exist in the given directory path.	Utils/RenderGridUtils.h
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.	Utils/RenderGridUtils.h
static TArray< uint8 > GetRemoteControlValueBytesFromJson ( const TArray< uint8 >& OldValueBytes, const FString& NewValueJson )	Converts a clean JSON string to low-level FProperty binary data.	Utils/RenderGridUtils.h
static FString GetRemoteControlValueJsonFromBytes ( const TArray< uint8 >& ValueBytes, const bool PrettyPrint )	Converts the low-level FProperty binary data to a clean JSON string.	Utils/RenderGridUtils.h
static bool IsImage ( const FString& ImagePath )	Returns true if the given file is likely a valid image.	Utils/RenderGridUtils.h
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).	Utils/RenderGridUtils.h
static FString NormalizeOutputDirectory ( const FString& OutputDirectory )	Returns a normalized directory path.	Utils/RenderGridUtils.h
static TSharedPtr< FJsonValue > ParseJson ( const FString& Json )	Parses the given JSON string and returns the FJsonValue.	Utils/RenderGridUtils.h
static FString PurgeJobId ( const FString& JobId )	Returns a job ID with all invalid characters removed from it.	Utils/RenderGridUtils.h
static FString PurgeJobIdOrGenerateUniqueId ( URenderGrid* Grid, const FString& JobId )	Returns a job ID with all invalid characters removed from it.	Utils/RenderGridUtils.h
static FString PurgeJobIdOrReturnEmptyString ( const FString& JobId )	Returns a job ID with all invalid characters removed from it.	Utils/RenderGridUtils.h
static FString PurgeJobName ( const FString& JobName )	Returns a job name with all invalid characters removed from it.	Utils/RenderGridUtils.h
static void RestoreFpsLimit ( const FRenderGridPreviousEngineFpsSettings& Settings )	Reverts back to the previous (given) state.	Utils/RenderGridUtils.h
static FString ToJsonString ( const TSharedPtr< FJsonValue >& Value, const bool PrettyPrint )	Converts the given FJsonValue to a string.	Utils/RenderGridUtils.h

Navigation

Syntax

Functions

Static