Class UserDefinedImageCaptureProtocol

A blueprintable capture protocol tailored to capturing and exporting frames as images

Inheritance
System.Object
UObject
MovieSceneCaptureProtocolBase
MovieSceneImageCaptureProtocolBase
UserDefinedCaptureProtocol
UserDefinedImageCaptureProtocol
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.MovieSceneCapture
Assembly: UE4DotNet.dll
Syntax
public class UserDefinedImageCaptureProtocol : UserDefinedCaptureProtocol

Properties

| Improve this Doc View Source

bEnableCompression

Declaration
public bool bEnableCompression { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CompressionQuality

The compression quality for the image type. For EXRs, 0 = Default ZIP compression, 1 = No compression, PNGs and JPEGs expect a value between 0 and 100

Declaration
public int CompressionQuality { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static UserDefinedImageCaptureProtocol DefaultObject { get; }
Property Value
Type Description
UserDefinedImageCaptureProtocol
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

GenerateFilenameForBuffer(Texture, Name)

  • Generate a filename for the specified buffer using this protocol's file name formatter
  • @
Declaration
public string GenerateFilenameForBuffer(Texture Buffer, Name StreamName)
Parameters
Type Name Description
Texture Buffer
Name StreamName
Returns
Type Description
System.String
Remarks

param Buffer The desired buffer to generate a filename for

  • @param StreamName The name of the stream for this buffer (e.g. a composition pass name)
  • @return A fully qualified file name
| Improve this Doc View Source

GenerateFilenameForCurrentFrame()

  • Generate a filename for the current frame using this protocol's file name formatter
  • @
Declaration
public string GenerateFilenameForCurrentFrame()
Returns
Type Description
System.String
Remarks

return A fully qualified file name for the current frame number

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static UserDefinedImageCaptureProtocol New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
UserDefinedImageCaptureProtocol
| Improve this Doc View Source

WriteImageToDisk(CapturedPixels, Name, FrameMetrics, Boolean)

  • Generate a filename for the current frame using this protocol's file name formatter
  • @
Declaration
public void WriteImageToDisk(CapturedPixels PixelData, Name StreamName, FrameMetrics FrameMetrics, bool bCopyImageData)
Parameters
Type Name Description
CapturedPixels PixelData
Name StreamName
FrameMetrics FrameMetrics
System.Boolean bCopyImageData
Remarks

return A fully qualified file name for the current frame number

Operators

| Improve this Doc View Source

Implicit(IntPtr to UserDefinedImageCaptureProtocol)

Convert from IntPtr to UObject

Declaration
public static implicit operator UserDefinedImageCaptureProtocol(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
UserDefinedImageCaptureProtocol