CreateStructuredBuffer

Function Overloads

API > API/Runtime > API/Runtime/RenderCore

Overloads

Name Remarks Include Path Unreal Specifiers

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
TArray< ElementType, AllocatorType >&& InitialData
)

 Helper to create a structured buffer with initial data from a TArray with move semantics, this can be cheaper as it guarantees the lifetimes of the data & permits copy-free upload. RenderGraphUtils.h  

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
GetArrayRefCallback&& ArrayCallback
)

 Same as the previous function but where the type of the array is automatically inferred, so we can do : TArray& Array = GraphBuilder.AllocArray<...>(); CreateStructuredBuffer(..., & -> auto&{ return Array; }); RenderGraphUtils.h  

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
const FRDGUploadData< ElementType >& InitialData
)

   RenderGraphUtils.h  

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
const TArray< ElementType, AllocatorType >& InitialData,
ERDGInitialDataFlags InitialDataFlags
)

 Helper to create a structured buffer with initial data from a TArray. RenderGraphUtils.h  

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
TConstArrayView< ElementType > InitialData,
ERDGInitialDataFlags InitialDataFlags
)

 Helper to create a structured buffer with initial data from a TConstArrayView. RenderGraphUtils.h  

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
uint32 BytesPerElement,
FRDGBufferNumElementsCallback&& NumElementsCallback,
FRDGBufferInitialDataCallback&& InitialDataCallback,
FRDGBufferInitialDataSizeCallback&& InitialDataSizeCallback
)

 A variant where NumElements, InitialData, and InitialDataSize are supplied through callbacks. RenderGraphUtils.h  

FRDGBufferRef CreateStructuredBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
uint32 BytesPerElement,
uint32 NumElements,
const void* InitialData,
uint64 InitialDataSize,
ERDGInitialDataFlags InitialDataFlags
)

 Creates a structured buffer with initial data by creating an upload pass. RenderGraphUtils.h  

CreateStructuredBuffer(FRDGBuilder &, const TCHAR *, TArray< ElementType, AllocatorType > &&)

Description

Helper to create a structured buffer with initial data from a TArray with move semantics, this can be cheaper as it guarantees the lifetimes of the data & permits copy-free upload.

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h" 
template<typename ElementType, typename AllocatorType>  
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    TArray < ElementType, AllocatorType > && InitialData  
)

CreateStructuredBuffer(FRDGBuilder &, const TCHAR *, GetArrayRefCallback &&)

Description

Same as the previous function but where the type of the array is automatically inferred, so we can do : TArray& Array = GraphBuilder.AllocArray<...>(); CreateStructuredBuffer(..., & -> auto&{ return Array; });

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h" 
template<typename GetArrayRefCallback, typename Type>  
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    GetArrayRefCallback && ArrayCallback  
)

CreateStructuredBuffer(FRDGBuilder &, const TCHAR *, const FRDGUploadData< ElementType > &)

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h" 
template<typename ElementType>  
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    const FRDGUploadData < ElementType > & InitialData  
)

CreateStructuredBuffer(FRDGBuilder &, const TCHAR *, const TArray< ElementType, AllocatorType > &, ERDGInitialDataFlags)

Description

Helper to create a structured buffer with initial data from a TArray.

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h" 
template<typename ElementType, typename AllocatorType>  
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    const TArray < ElementType, AllocatorType > & InitialData,  
    ERDGInitialDataFlags InitialDataFlags  
)

CreateStructuredBuffer(FRDGBuilder &, const TCHAR *, TConstArrayView< ElementType >, ERDGInitialDataFlags)

Description

Helper to create a structured buffer with initial data from a TConstArrayView.

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h" 
template<typename ElementType>  
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    TConstArrayView< ElementType > InitialData,  
    ERDGInitialDataFlags InitialDataFlags  
)

CreateStructuredBuffer(FRDGBuilder &, const TCHAR *, uint32, FRDGBufferNumElementsCallback &&, FRDGBufferInitialDataCallback &&, FRDGBufferInitialDataSizeCallback &&)

Description

A variant where NumElements, InitialData, and InitialDataSize are supplied through callbacks. This allows creating a buffer with information unknown at creation time. Though, data must be ready before the most recent RDG pass that references the buffer is executed.

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h"
Source /Engine/Source/Runtime/RenderCore/Private/RenderGraphUtils.cpp 
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    uint32 BytesPerElement,  
    FRDGBufferNumElementsCallback && NumElementsCallback,  
    FRDGBufferInitialDataCallback && InitialDataCallback,  
    FRDGBufferInitialDataSizeCallback && InitialDataSizeCallback  
)

CreateStructuredBuffer(FRDGBuilder &, const TCHAR , uint32, uint32, const void , uint64, ERDGInitialDataFlags)

Description

Creates a structured buffer with initial data by creating an upload pass.

   
Name CreateStructuredBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h"
Source /Engine/Source/Runtime/RenderCore/Private/RenderGraphUtils.cpp 
FRDGBufferRef CreateStructuredBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    uint32 BytesPerElement,  
    uint32 NumElements,  
    const void * InitialData,  
    uint64 InitialDataSize,  
    ERDGInitialDataFlags InitialDataFlags  
)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page