CreateByteAddressBuffer

Function Overloads

API > API/Runtime > API/Runtime/RenderCore

Overloads

Name Remarks Include Path Unreal Specifiers

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

 Helper to create a byte address 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 CreateByteAddressBuffer ( 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<...>(); CreateByteAddressBuffer(..., & -> auto&{ return Array; }); RenderGraphUtils.h  

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

   RenderGraphUtils.h  

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

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

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

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

FRDGBufferRef CreateByteAddressBuffer ( FRDGBuilder& GraphBuilder,
const TCHAR* Name,
uint32 NumBytes,
const void* InitialData,
uint64 InitialDataSize,
ERDGInitialDataFlags InitialDataFlags
)

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

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

Description

Helper to create a byte address 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 CreateByteAddressBuffer
Type function
Header File /Engine/Source/Runtime/RenderCore/Public/RenderGraphUtils.h
Include Path #include "RenderGraphUtils.h" 
template<typename ElementType, typename AllocatorType>  
FRDGBufferRef CreateByteAddressBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    TArray < ElementType, AllocatorType > && InitialData  
)

CreateByteAddressBuffer(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<...>(); CreateByteAddressBuffer(..., & -> auto&{ return Array; });

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

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

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

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

Description

Helper to create a byte address buffer with initial data from a TConstArrayView.

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

CreateByteAddressBuffer(FRDGBuilder &, const TCHAR *, 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. For byte address buffers, NumElements must be Size / 4.

   
Name CreateByteAddressBuffer
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 CreateByteAddressBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    FRDGBufferNumElementsCallback && NumElementsCallback,  
    FRDGBufferInitialDataCallback && InitialDataCallback,  
    FRDGBufferInitialDataSizeCallback && InitialDataSizeCallback  
)

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

Description

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

   
Name CreateByteAddressBuffer
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 CreateByteAddressBuffer  
(  
    FRDGBuilder & GraphBuilder,  
    const TCHAR * Name,  
    uint32 NumBytes,  
    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