VJ Master 1.0
Real-time audio analysis and visualisation.
Loading...
Searching...
No Matches
UST_VJ_ComputeFunctionLibrary Class Reference

Library providing utilities for creating and registering structured buffers. More...

#include <ST_VJ_ComputeFunctionLibrary.h>

Static Public Member Functions

static FRDGBufferRef CreateStructuredBuffer (FRDGBuilder &GraphBuilder, const TCHAR *Name, uint32 BytesPerElement, uint32 NumElements, bool bReadOnly=false)
static void RegisterSRV (FRDGBuilder &GraphBuilder, TRefCountPtr< FRDGPooledBuffer > buffer, FString name, FRDGBufferRef &outRDGRef, FRDGBufferSRVRef &outSRVRef, ERDGBufferFlags flags=ERDGBufferFlags::None)
static void RegisterUAV (FRDGBuilder &GraphBuilder, TRefCountPtr< FRDGPooledBuffer > buffer, FString name, FRDGBufferRef &outRDGRef, FRDGBufferUAVRef &outUAVRef, ERDGBufferFlags flags=ERDGBufferFlags::None)

Detailed Description

Library providing utilities for creating and registering structured buffers.

A Blueprint Function Library providing utilities for creating and registering structured buffers for compute shaders using the Render Dependency Graph (RDG) system.

Member Function Documentation

◆ CreateStructuredBuffer()

FRDGBufferRef UST_VJ_ComputeFunctionLibrary::CreateStructuredBuffer ( FRDGBuilder & GraphBuilder,
const TCHAR * Name,
uint32 BytesPerElement,
uint32 NumElements,
bool bReadOnly = false )
static

Creates a structured buffer for use in RDG-based compute shaders.

Parameters
GraphBuilderReference to the RDG builder.
NameDebug name for the buffer.
BytesPerElementSize of each element in bytes.
NumElementsNumber of elements in the buffer.
bReadOnlyWhether the buffer is read-only (SRV) or writable (UAV).
Returns
A reference to the created RDG buffer.

◆ RegisterSRV()

void UST_VJ_ComputeFunctionLibrary::RegisterSRV ( FRDGBuilder & GraphBuilder,
TRefCountPtr< FRDGPooledBuffer > buffer,
FString name,
FRDGBufferRef & outRDGRef,
FRDGBufferSRVRef & outSRVRef,
ERDGBufferFlags flags = ERDGBufferFlags::None )
static

Registers an SRV (Shader Resource View) from an existing pooled buffer with the RDG system.

Parameters
GraphBuilderReference to the RDG builder.
bufferPooled buffer to register.
nameDebug name for the SRV.
outRDGRefOutput RDG buffer reference.
outSRVRefOutput RDG SRV reference.
flagsOptional RDG buffer flags.

◆ RegisterUAV()

void UST_VJ_ComputeFunctionLibrary::RegisterUAV ( FRDGBuilder & GraphBuilder,
TRefCountPtr< FRDGPooledBuffer > buffer,
FString name,
FRDGBufferRef & outRDGRef,
FRDGBufferUAVRef & outUAVRef,
ERDGBufferFlags flags = ERDGBufferFlags::None )
static

Registers a UAV (Unordered Access View) from an existing pooled buffer with the RDG system.

Parameters
GraphBuilderReference to the RDG builder.
bufferPooled buffer to register.
nameDebug name for the UAV.
outRDGRefOutput RDG buffer reference.
outUAVRefOutput RDG UAV reference.
flagsOptional RDG buffer flags.

The documentation for this class was generated from the following files:
  • H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Compute/Utils/ST_VJ_ComputeFunctionLibrary.h
  • H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Compute/Utils/ST_VJ_ComputeFunctionLibrary.cpp