ACompositeSkySphereActor

Convenience actor providing image-based lighting from a plate texture.

API > API/Plugins > API/Plugins/Composite

Convenience actor providing image-based lighting from a plate texture. Wraps an inverted sphere mesh and a real-time skylight. Assign Texture and a sky sphere material with a "CompositeTexture" parameter to get image- based lighting from footage.

   
Name ACompositeSkySphereActor
Type class
Header File /Engine/Plugins/Compositing/Composite/Source/Composite/Public/CompositeSkySphereActor.h
Include Path #include "CompositeSkySphereActor.h"

Syntax

UCLASS (MinimalAPI)  
class ACompositeSkySphereActor : public AActor

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ACompositeSkySphereActor ( const FObjectInitializer& ObjectInitializer
)

   CompositeSkySphereActor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~ACompositeSkySphereActor()

   CompositeSkySphereActor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TextureParameterName FName Name of the texture parameter in the sky sphere material to receive Texture. CompositeSkySphereActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Texture"

Protected

Name Type Remarks Include Path Unreal Specifiers
meta   Texture to drive the sky sphere material's "CompositeTexture" parameter. CompositeSkySphereActor.h
  • EditAnywhere
  • Category="Texture"
  • Meta=(AllowPrivateAccess="true", AllowedClasses="/Script/Engine.Texture2D,/Script/Engine.Texture2DDynamic,/Script/Engine.TextureRenderTarget2D,/Script/MediaAssets.MediaTexture")
SkyLightComponent TObjectPtr< USkyLightComponent > Real-time skylight that captures the sky sphere for IBL. CompositeSkySphereActor.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Composite"
  • Meta=(AllowPrivateAccess="true")
SkySphereComponent TObjectPtr< UStaticMeshComponent > Sky sphere mesh component. CompositeSkySphereActor.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Composite"
  • Meta=(AllowPrivateAccess="true")

Functions

Public

Name Remarks Include Path Unreal Specifiers

UTexture * GetTexture()

 Returns the current sky sphere texture. CompositeSkySphereActor.h
  • BlueprintPure
  • Category="Texture"

void SetTexture ( UTexture* InTexture
)

 Sets the sky sphere texture and immediately updates the material. CompositeSkySphereActor.h
  • BlueprintCallable
  • Category="Texture"

Public Virtual

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   CompositeSkySphereActor.h  

virtual void OnConstruction ( const FTransform& Transform
)

   CompositeSkySphereActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CompositeSkySphereActor.h  

virtual void PostLoad()

   CompositeSkySphereActor.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   CompositeSkySphereActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page