Navigation
API > API/Plugins > API/Plugins/SharedMemoryMedia
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMediaCapture
- USharedMemoryMediaCapture
References
| Module | SharedMemoryMedia |
| Header | /Engine/Plugins/Runtime/nDisplay/Source/SharedMemoryMedia/Public/SharedMemoryMediaCapture.h |
| Include | #include "SharedMemoryMediaCapture.h" |
Syntax
UCLASS (BlueprintType)
class USharedMemoryMediaCapture : public UMediaCapture
Remarks
Output Media for SharedMemory.
The pixels are captured into shared cross gpu textures, that a player can read. Inter-process communication happens via shared system memory. The metadata exchanged is documented in the FSharedMemoryMediaFrameMetadata structure. The shared memory can be located via a UniqueName that must match in the Media Output and corresponding Media Source settings.
It is mostly intended for use in nDisplay render nodes, which are designed to be frame-locked.
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddCopyToSharedGpuTexturePass
(
FRDGBuilder& GraphBuilder, |
Adds to the graph builder the copy from the input texture to the shared gpu texture that corresponds to the current frame number |
 |
void | AddInvertAlphaConversionPass
(
FRDGBuilder& GraphBuilder, |
Adds a pass to invert the alpha of the texture |
Overridden from UMediaCapture
| Type | Name | Description | |
|---|---|---|---|
   |
EMediaCaptureResourceType | Get the desired output resource type when the conversion is custom. | |
   |
FIntPoint | GetCustomOutputSize
(
const FIntPoint& InSize |
For custom conversion, methods that need to be overridden |
  |
bool | Initialization method to prepare implementation for capture | |
  |
void | OnCustomCapture_RenderingThread
(
FRDGBuilder& GraphBuilder, |
Callback when the source texture is ready to be copied on the GPU. |
   |
bool | Should we call OnFrameCaptured_RenderingThread() with a RHI resource -or- readback the memory to CPU ram and call OnFrameCaptured_RenderingThread(). | |
  |
void | StopCaptureImpl
(
bool bAllowPendingFrameToBeProcess |
|
   |
bool | Whether the capture callbacks can be called on any thread. |
Constants
| Name | Description |
|---|---|
| NUMBUFFERS | Number of shared buffers |