Class SceneCaptureComponent2D

Used to capture a 'snapshot' of the scene from a single plane and feed it to a render target.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
SceneCaptureComponent
SceneCaptureComponent2D
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.Engine
Assembly: UE4DotNet.dll
Syntax
public class SceneCaptureComponent2D : SceneCaptureComponent

Properties

| Improve this Doc View Source

bCameraCutThisFrame

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

bEnableClipPlane

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

bUseCustomProjectionMatrix

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

CaptureSource

Capture Source

Declaration
public byte CaptureSource { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

ClipPlaneBase

Base position for the clip plane, can be any position on the plane.

Declaration
public Vector ClipPlaneBase { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

ClipPlaneNormal

Normal for the plane.

Declaration
public Vector ClipPlaneNormal { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

CompositeMode

When enabled, the scene capture will composite into the render target instead of overwriting its contents.

Declaration
public byte CompositeMode { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

CustomProjectionMatrix

The custom projection matrix to use

Declaration
public Matrix CustomProjectionMatrix { get; set; }
Property Value
Type Description
Matrix
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

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

FOVAngle

Camera field of view (in degrees).

Declaration
public float FOVAngle { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

OrthoWidth

The desired width (in world units) of the orthographic view (ignored in Perspective mode)

Declaration
public float OrthoWidth { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PostProcessBlendWeight

Range (0.0, 1.0) where 0 indicates no effect, 1 indicates full effect.

Declaration
public float PostProcessBlendWeight { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PostProcessSettings

Post Process Settings

Declaration
public PostProcessSettings PostProcessSettings { get; set; }
Property Value
Type Description
PostProcessSettings
| Improve this Doc View Source

ProjectionType

Projection Type

Declaration
public byte ProjectionType { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

StaticClass

Get UE4 Class

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

TextureTarget

Output render target of the scene capture that can be read in materals.

Declaration
public TextureRenderTarget2D TextureTarget { get; set; }
Property Value
Type Description
TextureRenderTarget2D

Methods

| Improve this Doc View Source

AddOrUpdateBlendable(Byte, Single)

Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight

Declaration
public void AddOrUpdateBlendable(byte InBlendableObject, float InWeight)
Parameters
Type Name Description
System.Byte InBlendableObject
System.Single InWeight
| Improve this Doc View Source

CaptureScene()

Render the scene to the texture target immediately.

Declaration
public void CaptureScene()
Remarks

This should not be used if bCaptureEveryFrame is enabled, or the scene capture will render redundantly.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static SceneCaptureComponent2D New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
SceneCaptureComponent2D

Operators

| Improve this Doc View Source

Implicit(IntPtr to SceneCaptureComponent2D)

Convert from IntPtr to UObject

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