1. Epic GamesDeveloper
  3. FMediaCaptureOptions

FMediaCaptureOptions

Base class of additional data that can be stored for each requested capture.

API > API/Plugins > API/Plugins/MediaIOCore

Base class of additional data that can be stored for each requested capture.

   
Name FMediaCaptureOptions
Type struct
Header File /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaCapture.h
Include Path #include "MediaCapture.h"

Syntax

USTRUCT (BlueprintType )  
struct FMediaCaptureOptions

Constructors

Name Remarks Include Path Unreal Specifiers

FMediaCaptureOptions()

   MediaCapture.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bApplyLinearToSRGBConversion bool Whether to apply a linear to sRGB conversion to the texture before outputting. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
  • Meta=(DisplayName="Apply linear to sRGB conversion")
bAutoRestartOnSourceSizeChange bool If source texture's size change, auto restart capture to follow source resolution if implementation supports it. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
bAutostopOnCapture bool Automatically stop capturing after a predetermined number of images. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
bConvertToDesiredPixelFormat bool Allows to enable/disable pixel format conversion for the cases where render target is not of the desired pixel format. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
bForceAlphaToOneOnConversion bool In some cases when we want to stream irregular render targets containing limited number of channels (for example RG16f), we would like to force Alpha to 1. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
bSkipFrameWhenRunningExpensiveTasks bool When the application enters responsive mode, skip the frame capture. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
CapturePhase EMediaCapturePhase   MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
ColorConversionSettings FOpenColorIOColorConversionSettings Color conversion settings used by the OCIO conversion pass. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
Crop EMediaCaptureCroppingType Crop the captured SceneViewport or TextureRenderTarget2D to the desired size. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
CustomCapturePoint FIntPoint Crop the captured SceneViewport or TextureRenderTarget2D to the desired size. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
  • Meta=(editcondition="Crop == EMediaCaptureCroppingType::Custom")
NumberOfFramesToCapture int32 The number of images to capture MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
  • Meta=(editcondition="bAutostopOnCapture")
OverrunAction EMediaCaptureOverrunAction Action to do when game thread overruns render thread and all frames are in flights being captured / readback. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
ResizeMethod EMediaCaptureResizeMethod When the capture start, control if and how the source buffer should be resized to the desired size. MediaCapture.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="MediaCapture"
  • Meta=(editcondition="Crop == EMediaCaptureCroppingType::None")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void PostSerialize ( const FArchive& Ar
)

   MediaCapture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page