Base class for sensors using a USceneCaptureComponent2D for rendering the scene. More...

#include <SceneCaptureSensor.h>

Inheritance diagram for ASceneCaptureSensor:

Public Member Functions
bool	ArePostProcessingEffectsEnabled () const

	ASceneCaptureSensor (const FObjectInitializer &ObjectInitializer)

void	Enable16BitFormat (bool Enable=false)

void	EnablePostProcessingEffects (bool Enable=true)

void	EnqueueRenderSceneImmediate ()
	Immediate enqueues render commands of the scene at the current time.

float	GetAOIntensity () const

float	GetAORadius () const

float	GetAperture () const

int	GetBladeCount () const

float	GetBloomIntensity () const

UTexture2D *	GetBloomKernelTexture () const

EBloomMethod	GetBloomMethod () const

float	GetBlueCorrection () const

USceneCaptureComponent2D_CARLA *	GetCaptureComponent () const

USceneCaptureComponent2D *	GetCaptureComponent2D ()

UTextureRenderTarget2D *	GetCaptureRenderTarget ()

float	GetChromAberrIntensity () const

float	GetChromAberrOffset () const

FVector4	GetColorContrast () const

FVector4	GetColorContrastHighlights () const

FVector4	GetColorContrastMidtones () const

FVector4	GetColorGamma () const

FVector4	GetColorSaturation () const

FVector4	GetColorSaturationHighlights () const

FVector4	GetColorSaturationMidtones () const

float	GetDepthBlurAmount () const

float	GetDepthBlurRadius () const

float	GetDepthOfFieldMinFstop () const

float	GetDetailStrength () const

float	GetDirtMaskIntensity () const

float	GetExposureCalibrationConstant () const

float	GetExposureCompensation () const

float	GetExposureMaxBrightness () const

EAutoExposureMethod	GetExposureMethod () const

float	GetExposureMinBrightness () const

float	GetExposureSpeedDown () const

float	GetExposureSpeedUp () const

float	GetFilmBlackClip () const

float	GetFilmGrainIntensity () const

float	GetFilmShoulder () const

float	GetFilmSlope () const

float	GetFilmToe () const

float	GetFilmWhiteClip () const

float	GetFocalDistance () const

float	GetFOVAngle () const

FVector4	GetGlobalGain () const

float	GetHighlightContrastScale () const

FVector4	GetHighlightsGamma () const

uint32	GetImageHeight () const

uint32	GetImageWidth () const

float	GetISO () const

float	GetLensFlareIntensity () const

ELocalExposureMethod	GetLocalExposureMethod () const

float	GetMotionBlurIntensity () const

float	GetMotionBlurMaxDistortion () const

float	GetMotionBlurMinObjectScreenSize () const

FRHIGPUReadbackPoolPtr	GetReadbackPool () const
	Per-sensor pool of recyclable RHI readback objects.

FLinearColor	GetSceneColorTint () const

float	GetSensorWidth () const

float	GetShadowContrastScale () const

const FCarlaShowOnlyFilter &	GetShowOnlyFilter () const

float	GetShutterSpeed () const

float	GetTargetGamma () const

float	GetToneCurveAmount () const

bool	GetUseRayTracing () const

float	GetVignetteIntensity () const

float	GetWhiteTemp () const

float	GetWhiteTint () const

bool	Is16BitFormatEnabled () const

bool	IsDLSSUpscaleEnabled () const

bool	IsShowOnlyEnabled () const

bool	ReadPixels (TArray< FColor > &BitMap) const
	Use for debugging purposes only.

void	SaveCaptureToDisk (const FString &FilePath) const
	Use for debugging purposes only.

void	Set (const FActorDescription &ActorDescription) override

void	SetAOIntensity (float Intensity)

void	SetAORadius (float Radius)

void	SetAperture (float Aperture)

void	SetBladeCount (int Count)

void	SetBloomConvolutionTexture (UTexture2D *Texture)

void	SetBloomIntensity (float Intensity)

void	SetBloomMethod (EBloomMethod Method)

void	SetBlueCorrection (float Val)

void	SetChromAberrIntensity (float Intensity)

void	SetChromAberrOffset (float ChromAberrOffset)

void	SetColorContrast (FVector4 ColorContrast)

void	SetColorContrastHighlights (FVector4 ColorContrast)

void	SetColorContrastMidtones (FVector4 ColorContrast)

void	SetColorGamma (FVector4 ColorGamma)

void	SetColorSaturation (FVector4 ColorSaturation)

void	SetColorSaturationHighlights (FVector4 ColorSaturation)

void	SetColorSaturationMidtones (FVector4 ColorSaturation)

void	SetDepthBlurAmount (float Amount)

void	SetDepthBlurRadius (float Radius)

void	SetDepthOfFieldMinFstop (float MinFstop)

void	SetDetailStrength (float Val)

void	SetDirtMaskIntensity (float Intensity)

void	SetDLSSUpscale (bool Enable, float ScreenPercentage)
	Render the capture at ScreenPercentage (25-100) of the target resolution and upscale it back with DLSS Super Resolution when available (bilinear otherwise).

void	SetExposureCalibrationConstant (float Constant)

void	SetExposureCompensation (float Compensation)

void	SetExposureMaxBrightness (float Brightness)

void	SetExposureMethod (EAutoExposureMethod Method)

void	SetExposureMinBrightness (float Brightness)

void	SetExposureSpeedDown (float Speed)

void	SetExposureSpeedUp (float Speed)

void	SetFilmBlackClip (float BlackClip)

void	SetFilmGrainIntensity (float Val)

void	SetFilmShoulder (float Shoulder)

void	SetFilmSlope (float Slope)

void	SetFilmToe (float Toe)

void	SetFilmWhiteClip (float WhiteClip)

void	SetFocalDistance (float Distance)

void	SetFOVAngle (float FOVAngle)

void	SetGlobalGain (FVector4 Gain)

void	SetHighlightContrastScale (float HighlightContrastScale)

void	SetHighlightsGamma (FVector4 HighlightsGamma)

void	SetImageSize (uint32 Width, uint32 Height)

void	SetISO (float ISO)

void	SetLensFlareIntensity (float Intensity)

void	SetLocalExposureMethod (ELocalExposureMethod Method)

void	SetMotionBlurIntensity (float Intensity)

void	SetMotionBlurMaxDistortion (float MaxDistortion)

void	SetMotionBlurMinObjectScreenSize (float ScreenSize)

void	SetSceneColorTint (FLinearColor SceneColorTint)

void	SetSensorWidth (float Width)

void	SetShadowCatcherTags (const FString &CommaSeparatedLabels)
	Labels whose actors are rendered alongside the show-only set so they receive its cast shadows ("Roads,Sidewalks").

void	SetShadowContrastScale (float ShadowContrastScale)

void	SetShowOnlyActorIds (const FString &CommaSeparatedIds)
	CARLA actor ids always included in the show-only set.

void	SetShowOnlyTags (const FString &CommaSeparatedLabels)
	Show-only render mode (see FCarlaShowOnlyFilter): comma separated semantic label names.

void	SetShutterSpeed (float Speed)

void	SetTargetGamma (float InTargetGamma)

void	SetToneCurveAmount (float ToneCurveAmount)

void	SetUseRayTracing (bool Enable)

void	SetVignetteIntensity (float VignetteIntensity)

void	SetWhiteTemp (float Temp)

void	SetWhiteTint (float Tint)

virtual void	UpdatePostProcessConfig (FPostProcessConfig &InOutPostProcessConfig)

void	WaitForRenderThreadToFinish ()
	Blocks until the render thread has finished all it's tasks.

Public Member Functions inherited from ASensor
bool	AreClientsListening ()

	ASensor (const FObjectInitializer &ObjectInitializer)

void	ClearReadyToTick ()

std::optional< FActorAttribute >	GetAttribute (const FString Name)

const UCarlaEpisode &	GetEpisode () const

virtual void	GetMirrorState (carla::multigpu::SensorState &State) const
	Multi-GPU: the runtime state this sensor starts its next tick from (noise generator, sweep angle, history).

URandomEngine *	GetRandomEngine ()

float	GetReadyToTickDeltaSeconds () const

int32	GetSeed () const

auto	GetToken () const
	Return the token that allows subscribing to this sensor's stream.

bool	IsReadyToTick () const

bool	IsStreamReady ()

FDataStream	MoveDataStream ()

virtual void	OnFirstClientConnected ()

virtual void	OnLastClientDisconnected ()

void	PostPhysTickInternal (UWorld *World, ELevelTick TickType, float DeltaSeconds)

void	SetDataStream (FDataStream InStream)
	Replace the FDataStream associated with this sensor.

void	SetEpisode (const UCarlaEpisode &InEpisode)

virtual void	SetMirrorState (const carla::multigpu::SensorState &State)

void	SetPrimaryTick (float DeltaSeconds)
	Multi-GPU secondary: tick in this engine frame, with the primary's delta.

void	SetSavingDataToDisk (bool bSavingData)

void	SetSeed (int32 InSeed)

void	Tick (const float DeltaTime) final

Static Public Member Functions
static bool	ApplyPostProcessVolumeToSensor (APostProcessVolume Origin, ASceneCaptureSensor Dest, bool bOverrideCurrentCamera=false)

static bool	ResolveCameraRayTracing (bool bSensorEnabled, bool bRequired)
	Applies the `carla.Camera.UseRayTracing` tier policy to a camera's own ray-tracing preference.

Static Public Member Functions inherited from ASensor
static FSensorCaptureContext	MakeCaptureContext (const ASensor &Sensor)
	Call on the game thread right after CaptureScene().

Public Attributes
struct {

FCameraGBufferUint8 CustomDepth

FCameraGBufferUint8 CustomStencil

FCameraGBufferUint8 GBufferA

FCameraGBufferUint8 GBufferB

FCameraGBufferUint8 GBufferC

FCameraGBufferUint8 GBufferD

FCameraGBufferUint8 GBufferE

FCameraGBufferUint8 GBufferF

FCameraGBufferUint8 SceneColor

FCameraGBufferUint8 SceneDepth

FCameraGBufferUint8 SceneStencil

FCameraGBufferUint8 SSAO

FCameraGBufferUint8 Velocity

}	CameraGBuffers

Protected Member Functions
virtual void	BeginPlay () override

void	CaptureSceneExtended ()

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

bool	IsAnyGBufferClientListening () const
	Returns true if any GBuffer stream has an active listener.

virtual void	PostPhysTick (UWorld *World, ELevelTick TickType, float DeltaTime) override

virtual void	PrePhysTick (float DeltaSeconds) override

virtual bool	RequiresRayTracing () const
	True for sensors that cannot render without hardware ray tracing (path-traced lens cameras); the tier policy never switches them off.

virtual void	SetUpSceneCaptureComponent (USceneCaptureComponent2D &SceneCapture)

bool	ShouldCaptureThisFrame ()
	Aggregate gate: main stream or any GBuffer stream has listeners, or CVarCarlaCameraForceAllGBuffers forces every frame.

void	UpdateExposureMotionBlur (UWorld *World, float DeltaTime)
	Motion blur from the auto exposure time (carla.Camera.ExposureMotionBlur).

Protected Member Functions inherited from ASensor
void	EndPlay (EEndPlayReason::Type EndPlayReason) override

template<typename SensorType >
FAsyncDataStream	GetDataStream (SensorType &&Self)
	Return the FDataStream associated with this sensor.

void	PostActorCreated () override

Protected Attributes
bool	bEnable16BitFormat = false
	Whether to change render target format to PF_A16B16G16R16, offering 16bit / channel.

bool	bEnableDLSSUpscale = false
	Render the capture at DLSSScreenPercentage of the target resolution and upscale back with DLSS Super Resolution (engine scene-capture temporal upscaler; bilinear fallback without NVIDIA hardware).

bool	bEnablePostProcessingEffects = true
	Whether to render the post-processing effects present in the scene.

bool	bUseRayTracing = true
	Whether this sensor uses hardware ray tracing for its scene capture.

TObjectPtr< USceneCaptureComponent2D_CARLA >	CaptureComponent2D = nullptr
	Scene capture component.

TObjectPtr< UTextureRenderTarget2D >	CaptureRenderTarget = nullptr
	Render target necessary for scene capture.

float	DLSSScreenPercentage = 50.0f
	Internal render resolution as a percentage of the target resolution when bEnableDLSSUpscale is set.

float	ExposureSeconds = 0.0f
	Exposure time of the last capture in seconds (exposure-linked motion blur).

uint32	ImageHeight = 600u
	Image height in pixels.

uint32	ImageWidth = 800u
	Image width in pixels.

double	LastCaptureTime = -1.0
	Simulation time of this sensor's previous capture (-1 before the first).

FRHIGPUReadbackPoolPtr	ReadbackPool
	Per-sensor pool of recyclable RHI readback objects.

FCarlaShowOnlyFilter	ShowOnlyFilter
	Show-only actor filter, applied to the capture component right before every capture (see FCarlaShowOnlyFilter).

float	TargetGamma = 2.2f

Protected Attributes inherited from ASensor
bool	bIsActive = false

bool	bSavingDataToDisk = false

URandomEngine *	RandomEngine = nullptr
	Random Engine used to provide noise for sensor output.

int32	Seed = 123456789
	Seed of the pseudo-random engine.

Private Member Functions
void	ApplyRayTracingSetting ()

Private Attributes
int32	NumCaptures = 0
	Captures rendered as camera cuts since BeginPlay (carla.Camera.SpawnCameraCuts).

Friends
class	ACarlaGameModeBase

class	FPixelReader

class	FPixelReader2

Additional Inherited Members
Static Protected Member Functions inherited from ASensor
template<typename SensorType , typename ElementType >
static void	SendDataToClient (SensorType &&Sensor, TArrayView< ElementType > SensorData, const FSensorCaptureContext &CaptureContext)

Detailed Description

Base class for sensors using a USceneCaptureComponent2D for rendering the scene.

This class does not capture data, use FPixelReader::SendPixelsInRenderThread<FColor>(*this) in derived classes.

To access the USceneCaptureComponent2D override the SetUpSceneCaptureComponent function.

Warning: All the setters should be called before BeginPlay.

Definition at line 124 of file SceneCaptureSensor.h.

Constructor & Destructor Documentation

◆ ASceneCaptureSensor()

ASceneCaptureSensor::ASceneCaptureSensor ( const FObjectInitializer & ObjectInitializer )

Definition at line 135 of file SceneCaptureSensor.cpp.

References ApplyRayTracingSetting(), CaptureComponent2D, CaptureRenderTarget, SCENE_CAPTURE_COUNTER, and SceneCaptureSensor_local_ns::SetCameraDefaultOverrides().

Member Function Documentation

◆ ApplyPostProcessVolumeToSensor()

bool ASceneCaptureSensor::ApplyPostProcessVolumeToSensor	(	APostProcessVolume *	Origin,
		ASceneCaptureSensor *	Dest,
		bool	bOverrideCurrentCamera = `false`
	)

static

Definition at line 868 of file SceneCaptureSensor.cpp.

References CaptureComponent2D, GetAOIntensity(), GetAORadius(), GetAperture(), GetBladeCount(), GetBloomIntensity(), GetBloomKernelTexture(), GetBloomMethod(), GetBlueCorrection(), GetChromAberrIntensity(), GetChromAberrOffset(), GetColorContrast(), GetColorContrastHighlights(), GetColorContrastMidtones(), GetColorSaturation(), GetColorSaturationHighlights(), GetColorSaturationMidtones(), GetDepthBlurAmount(), GetDepthBlurRadius(), GetDepthOfFieldMinFstop(), GetDetailStrength(), GetDirtMaskIntensity(), GetExposureCalibrationConstant(), GetExposureCompensation(), GetExposureMaxBrightness(), GetExposureMethod(), GetExposureMinBrightness(), GetExposureSpeedDown(), GetExposureSpeedUp(), GetFilmBlackClip(), GetFilmGrainIntensity(), GetFilmShoulder(), GetFilmSlope(), GetFilmToe(), GetFilmWhiteClip(), GetFocalDistance(), GetGlobalGain(), GetISO(), GetLensFlareIntensity(), GetLocalExposureMethod(), GetMotionBlurIntensity(), GetMotionBlurMaxDistortion(), GetMotionBlurMinObjectScreenSize(), GetShutterSpeed(), GetTargetGamma(), GetWhiteTemp(), GetWhiteTint(), IsValid(), SetAOIntensity(), SetAORadius(), SetAperture(), SetBladeCount(), SetBloomConvolutionTexture(), SetBloomIntensity(), SetBloomMethod(), SetBlueCorrection(), SetChromAberrIntensity(), SetChromAberrOffset(), SetColorContrast(), SetColorContrastHighlights(), SetColorContrastMidtones(), SetColorSaturation(), SetColorSaturationHighlights(), SetColorSaturationMidtones(), SetDepthBlurAmount(), SetDepthBlurRadius(), SetDepthOfFieldMinFstop(), SetDetailStrength(), SetDirtMaskIntensity(), SetExposureCalibrationConstant(), SetExposureCompensation(), SetExposureMaxBrightness(), SetExposureMethod(), SetExposureMinBrightness(), SetExposureSpeedDown(), SetExposureSpeedUp(), SetFilmBlackClip(), SetFilmGrainIntensity(), SetFilmShoulder(), SetFilmSlope(), SetFilmToe(), SetFilmWhiteClip(), SetFocalDistance(), SetGlobalGain(), SetISO(), SetLensFlareIntensity(), SetLocalExposureMethod(), SetMotionBlurIntensity(), SetMotionBlurMaxDistortion(), SetMotionBlurMinObjectScreenSize(), SetShutterSpeed(), SetTargetGamma(), SetWhiteTemp(), and SetWhiteTint().

Referenced by BeginPlay().

◆ ApplyRayTracingSetting()

void ASceneCaptureSensor::ApplyRayTracingSetting ( )

private

Definition at line 190 of file SceneCaptureSensor.cpp.

References bUseRayTracing, CaptureComponent2D, RequiresRayTracing(), and ResolveCameraRayTracing().

Referenced by ASceneCaptureSensor(), and SetUseRayTracing().

◆ ArePostProcessingEffectsEnabled()

bool ASceneCaptureSensor::ArePostProcessingEffectsEnabled ( ) const

inline

Definition at line 161 of file SceneCaptureSensor.h.

Referenced by BeginPlay(), and UpdateExposureMotionBlur().

◆ BeginPlay()

void ASceneCaptureSensor::BeginPlay ( )

overrideprotectedvirtual

◆ CaptureSceneExtended()

void ASceneCaptureSensor::CaptureSceneExtended ( )

protected

Referenced by EnqueueRenderSceneImmediate().

◆ Enable16BitFormat()

void ASceneCaptureSensor::Enable16BitFormat ( bool Enable = false )

inline

Definition at line 233 of file SceneCaptureSensor.h.

Referenced by ANormalsCamera::ANormalsCamera(), and AOpticalFlowCamera::AOpticalFlowCamera().

◆ EnablePostProcessingEffects()

void ASceneCaptureSensor::EnablePostProcessingEffects ( bool Enable = true )

inline

Definition at line 155 of file SceneCaptureSensor.h.

Referenced by ADVSCamera::ADVSCamera(), ASceneCaptureCamera_RayTracedLensDistance::ASceneCaptureCamera_RayTracedLensDistance(), ASceneCaptureCamera_RayTracedLensInstance::ASceneCaptureCamera_RayTracedLensInstance(), AShaderBasedSensor::AShaderBasedSensor(), and UActorBlueprintFunctionLibrary::SetCamera().

◆ EndPlay()

void ASceneCaptureSensor::EndPlay ( const EEndPlayReason::Type EndPlayReason )

overrideprotectedvirtual

Reimplemented in ASceneCaptureCamera, and ASceneCaptureCamera_RayTracedLens.

Definition at line 1241 of file SceneCaptureSensor.cpp.

References CaptureComponent2D, CaptureRenderTarget, and ReadbackPool.

◆ EnqueueRenderSceneImmediate()

void ASceneCaptureSensor::EnqueueRenderSceneImmediate ( )

Immediate enqueues render commands of the scene at the current time.

Definition at line 982 of file SceneCaptureSensor.cpp.

References FCarlaShowOnlyFilter::ApplyTo(), CaptureComponent2D, CaptureSceneExtended(), CVarCarlaCameraSpawnCameraCuts(), EnqueueRenderSceneImmediate(), GetCaptureComponent2D(), ASensor::GetEpisode(), FCarlaShowOnlyFilter::IsEnabled(), NumCaptures, FCarlaShowOnlyFilter::Refresh(), and ShowOnlyFilter.

Referenced by EnqueueRenderSceneImmediate(), and PostPhysTick().

◆ GetAOIntensity()

float ASceneCaptureSensor::GetAOIntensity ( ) const

Definition at line 821 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetAORadius()

float ASceneCaptureSensor::GetAORadius ( ) const

Definition at line 833 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetAperture()

float ASceneCaptureSensor::GetAperture ( ) const

Definition at line 323 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetBladeCount()

int ASceneCaptureSensor::GetBladeCount ( ) const

Definition at line 395 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetBloomIntensity()

float ASceneCaptureSensor::GetBloomIntensity ( ) const

Definition at line 581 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetBloomKernelTexture()

UTexture2D * ASceneCaptureSensor::GetBloomKernelTexture ( ) const

Definition at line 263 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetBloomMethod()

EBloomMethod ASceneCaptureSensor::GetBloomMethod ( ) const

Definition at line 257 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetBlueCorrection()

float ASceneCaptureSensor::GetBlueCorrection ( ) const

Definition at line 785 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetCaptureComponent()

USceneCaptureComponent2D_CARLA * ASceneCaptureSensor::GetCaptureComponent ( ) const

inline

Definition at line 139 of file SceneCaptureSensor.h.

Referenced by UActorBlueprintFunctionLibrary::SetCamera().

◆ GetCaptureComponent2D()

USceneCaptureComponent2D * ASceneCaptureSensor::GetCaptureComponent2D ( )

inline

Definition at line 600 of file SceneCaptureSensor.h.

Referenced by AWeather::CheckWeatherPostProcessEffects(), and EnqueueRenderSceneImmediate().

◆ GetCaptureRenderTarget()

UTextureRenderTarget2D * ASceneCaptureSensor::GetCaptureRenderTarget ( )

inline

Definition at line 606 of file SceneCaptureSensor.h.

Referenced by ASceneCaptureCamera_RayTracedLensDistance::BeginPlay(), ASceneCaptureCamera_RayTracedLens::PostPhysTick(), ASceneCaptureCamera_RayTracedLensDistance::PostPhysTick(), ASceneCaptureCamera_RayTracedLensInstance::PostPhysTick(), ImageUtil::ReadSensorImageDataAsync(), ImageUtil::ReadSensorImageDataAsyncFColor(), and ImageUtil::ReadSensorImageDataAsyncFLinearColor().

◆ GetChromAberrIntensity()

float ASceneCaptureSensor::GetChromAberrIntensity ( ) const

Definition at line 617 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetChromAberrOffset()

float ASceneCaptureSensor::GetChromAberrOffset ( ) const

Definition at line 629 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetColorContrast()

FVector4 ASceneCaptureSensor::GetColorContrast ( ) const

Definition at line 677 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetColorContrastHighlights()

FVector4 ASceneCaptureSensor::GetColorContrastHighlights ( ) const

Definition at line 701 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetColorContrastMidtones()

FVector4 ASceneCaptureSensor::GetColorContrastMidtones ( ) const

Definition at line 689 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetColorGamma()

FVector4 ASceneCaptureSensor::GetColorGamma ( ) const

Definition at line 713 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetColorSaturation()

FVector4 ASceneCaptureSensor::GetColorSaturation ( ) const

Definition at line 641 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetColorSaturationHighlights()

FVector4 ASceneCaptureSensor::GetColorSaturationHighlights ( ) const

Definition at line 665 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetColorSaturationMidtones()

FVector4 ASceneCaptureSensor::GetColorSaturationMidtones ( ) const

Definition at line 653 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetDepthBlurAmount()

float ASceneCaptureSensor::GetDepthBlurAmount ( ) const

Definition at line 359 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetDepthBlurRadius()

float ASceneCaptureSensor::GetDepthBlurRadius ( ) const

Definition at line 371 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetDepthOfFieldMinFstop()

float ASceneCaptureSensor::GetDepthOfFieldMinFstop ( ) const

Definition at line 383 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetDetailStrength()

float ASceneCaptureSensor::GetDetailStrength ( ) const

Definition at line 797 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetDirtMaskIntensity()

float ASceneCaptureSensor::GetDirtMaskIntensity ( ) const

Definition at line 221 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureCalibrationConstant()

float ASceneCaptureSensor::GetExposureCalibrationConstant ( ) const

Definition at line 515 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureCompensation()

float ASceneCaptureSensor::GetExposureCompensation ( ) const

Definition at line 287 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureMaxBrightness()

float ASceneCaptureSensor::GetExposureMaxBrightness ( ) const

Definition at line 479 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureMethod()

EAutoExposureMethod ASceneCaptureSensor::GetExposureMethod ( ) const

Definition at line 269 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureMinBrightness()

float ASceneCaptureSensor::GetExposureMinBrightness ( ) const

Definition at line 467 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureSpeedDown()

float ASceneCaptureSensor::GetExposureSpeedDown ( ) const

Definition at line 491 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetExposureSpeedUp()

float ASceneCaptureSensor::GetExposureSpeedUp ( ) const

Definition at line 503 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFilmBlackClip()

float ASceneCaptureSensor::GetFilmBlackClip ( ) const

Definition at line 443 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFilmGrainIntensity()

float ASceneCaptureSensor::GetFilmGrainIntensity ( ) const

Definition at line 809 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFilmShoulder()

float ASceneCaptureSensor::GetFilmShoulder ( ) const

Definition at line 431 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFilmSlope()

float ASceneCaptureSensor::GetFilmSlope ( ) const

Definition at line 407 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFilmToe()

float ASceneCaptureSensor::GetFilmToe ( ) const

Definition at line 419 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFilmWhiteClip()

float ASceneCaptureSensor::GetFilmWhiteClip ( ) const

Definition at line 455 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFocalDistance()

float ASceneCaptureSensor::GetFocalDistance ( ) const

Definition at line 347 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetFOVAngle()

float ASceneCaptureSensor::GetFOVAngle ( ) const

Definition at line 215 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetGlobalGain()

FVector4 ASceneCaptureSensor::GetGlobalGain ( ) const

Definition at line 773 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetHighlightContrastScale()

float ASceneCaptureSensor::GetHighlightContrastScale ( ) const

Definition at line 845 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetHighlightsGamma()

FVector4 ASceneCaptureSensor::GetHighlightsGamma ( ) const

Definition at line 725 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetImageHeight()

uint32 ASceneCaptureSensor::GetImageHeight ( ) const

inline

Definition at line 149 of file SceneCaptureSensor.h.

Referenced by ASceneCaptureCamera_RayTracedLensDistance::BeginPlay(), ADVSCamera::ImageToGray(), ADVSCamera::ImageToLogGray(), ASceneCaptureCamera_RayTracedLens::Set(), and ADVSCamera::Simulation().

◆ GetImageWidth()

uint32 ASceneCaptureSensor::GetImageWidth ( ) const

inline

Definition at line 144 of file SceneCaptureSensor.h.

Referenced by ASceneCaptureCamera_RayTracedLensDistance::BeginPlay(), ADVSCamera::ImageToGray(), ADVSCamera::ImageToLogGray(), ASceneCaptureCamera_RayTracedLens::Set(), and ADVSCamera::Simulation().

◆ GetISO()

float ASceneCaptureSensor::GetISO ( ) const

Definition at line 311 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetLensFlareIntensity()

float ASceneCaptureSensor::GetLensFlareIntensity ( ) const

Definition at line 563 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetLocalExposureMethod()

ELocalExposureMethod ASceneCaptureSensor::GetLocalExposureMethod ( ) const

Definition at line 239 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetMotionBlurIntensity()

float ASceneCaptureSensor::GetMotionBlurIntensity ( ) const

Definition at line 527 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetMotionBlurMaxDistortion()

float ASceneCaptureSensor::GetMotionBlurMaxDistortion ( ) const

Definition at line 539 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetMotionBlurMinObjectScreenSize()

float ASceneCaptureSensor::GetMotionBlurMinObjectScreenSize ( ) const

Definition at line 551 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetReadbackPool()

FRHIGPUReadbackPoolPtr ASceneCaptureSensor::GetReadbackPool ( ) const

inline

Per-sensor pool of recyclable RHI readback objects.

May be null before BeginPlay or after EndPlay; consumers fall back to a per-call alloc in that case.

Definition at line 614 of file SceneCaptureSensor.h.

Referenced by ASceneCaptureCamera_RayTracedLens::PostPhysTick(), ASceneCaptureCamera_RayTracedLensDistance::PostPhysTick(), ASceneCaptureCamera_RayTracedLensInstance::PostPhysTick(), ImageUtil::ReadSensorImageDataAsync(), ImageUtil::ReadSensorImageDataAsyncFColor(), and ImageUtil::ReadSensorImageDataAsyncFLinearColor().

◆ GetSceneColorTint()

FLinearColor ASceneCaptureSensor::GetSceneColorTint ( ) const

Definition at line 749 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetSensorWidth()

float ASceneCaptureSensor::GetSensorWidth ( ) const

Definition at line 335 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetShadowContrastScale()

float ASceneCaptureSensor::GetShadowContrastScale ( ) const

Definition at line 857 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetShowOnlyFilter()

const FCarlaShowOnlyFilter & ASceneCaptureSensor::GetShowOnlyFilter ( ) const

inline

Definition at line 227 of file SceneCaptureSensor.h.

◆ GetShutterSpeed()

float ASceneCaptureSensor::GetShutterSpeed ( ) const

Definition at line 299 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetTargetGamma()

float ASceneCaptureSensor::GetTargetGamma ( ) const

inline

Definition at line 257 of file SceneCaptureSensor.h.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetToneCurveAmount()

float ASceneCaptureSensor::GetToneCurveAmount ( ) const

Definition at line 737 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetUseRayTracing()

bool ASceneCaptureSensor::GetUseRayTracing ( ) const

inline

Definition at line 186 of file SceneCaptureSensor.h.

◆ GetVignetteIntensity()

float ASceneCaptureSensor::GetVignetteIntensity ( ) const

Definition at line 761 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ GetWhiteTemp()

float ASceneCaptureSensor::GetWhiteTemp ( ) const

Definition at line 593 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ GetWhiteTint()

float ASceneCaptureSensor::GetWhiteTint ( ) const

Definition at line 605 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ Is16BitFormatEnabled()

bool ASceneCaptureSensor::Is16BitFormatEnabled ( ) const

inline

Definition at line 239 of file SceneCaptureSensor.h.

◆ IsAnyGBufferClientListening()

bool ASceneCaptureSensor::IsAnyGBufferClientListening ( ) const

protected

Returns true if any GBuffer stream has an active listener.

Definition at line 1122 of file SceneCaptureSensor.cpp.

References CameraGBuffers.

Referenced by ShouldCaptureThisFrame().

◆ IsDLSSUpscaleEnabled()

bool ASceneCaptureSensor::IsDLSSUpscaleEnabled ( ) const

inline

Definition at line 177 of file SceneCaptureSensor.h.

◆ IsShowOnlyEnabled()

bool ASceneCaptureSensor::IsShowOnlyEnabled ( ) const

inline

Definition at line 222 of file SceneCaptureSensor.h.

◆ PostPhysTick()

void ASceneCaptureSensor::PostPhysTick	(	UWorld *	World,
		ELevelTick	TickType,
		float	DeltaTime
	)

overrideprotectedvirtual

Reimplemented from ASensor.

Reimplemented in ADepthCamera, AInstanceSegmentationCamera, ANormalsCamera, AOpticalFlowCamera, ASceneCaptureCamera, ASceneCaptureCamera_RayTracedLens, ASceneCaptureCamera_RayTracedLensDistance, ASceneCaptureCamera_RayTracedLensInstance, ASemanticSegmentationCamera, and ADVSCamera.

Definition at line 1185 of file SceneCaptureSensor.cpp.

References EnqueueRenderSceneImmediate(), PostPhysTick(), ShouldCaptureThisFrame(), and UpdateExposureMotionBlur().

Referenced by PostPhysTick(), and ASceneCaptureCamera_RayTracedLens::TickCaptureAndReadback().

◆ PrePhysTick()

void ASceneCaptureSensor::PrePhysTick ( float DeltaSeconds )

overrideprotectedvirtual

Reimplemented from ASensor.

Definition at line 1165 of file SceneCaptureSensor.cpp.

References CaptureComponent2D, ImageWidth, PrePhysTick(), and ShouldCaptureThisFrame().

Referenced by PrePhysTick().

◆ ReadPixels()

bool ASceneCaptureSensor::ReadPixels ( TArray< FColor > & BitMap ) const

inline

Use for debugging purposes only.

Definition at line 585 of file SceneCaptureSensor.h.

References FPixelReader::WritePixelsToArray().

Referenced by ADVSCamera::PostPhysTick().

◆ RequiresRayTracing()

virtual bool ASceneCaptureSensor::RequiresRayTracing ( ) const

inlineprotectedvirtual

True for sensors that cannot render without hardware ray tracing (path-traced lens cameras); the tier policy never switches them off.

Reimplemented in ASceneCaptureCamera_RayTracedLens.

Definition at line 649 of file SceneCaptureSensor.h.

Referenced by ApplyRayTracingSetting().

◆ ResolveCameraRayTracing()

bool ASceneCaptureSensor::ResolveCameraRayTracing	(	bool	bSensorEnabled,
		bool	bRequired
	)

static

Applies the carla.Camera.UseRayTracing tier policy to a camera's own ray-tracing preference.

A camera that cannot render without ray tracing passes bRequired and is never switched off by the policy.

Definition at line 199 of file SceneCaptureSensor.cpp.

References GetCameraRayTracingOverride().

Referenced by ApplyRayTracingSetting(), and ASceneCaptureSensor_WideAngleLens::SetUseRayTracing().

◆ SaveCaptureToDisk()

void ASceneCaptureSensor::SaveCaptureToDisk ( const FString & FilePath ) const

inline

Use for debugging purposes only.

Definition at line 593 of file SceneCaptureSensor.h.

References FPixelReader::SavePixelsToDisk().

◆ Set()

void ASceneCaptureSensor::Set ( const FActorDescription & ActorDescription )

overridevirtual

Reimplemented from ASensor.

Reimplemented in AShaderBasedSensor.

Definition at line 172 of file SceneCaptureSensor.cpp.

References UActorBlueprintFunctionLibrary::SetCamera().

◆ SetAOIntensity()

void ASceneCaptureSensor::SetAOIntensity ( float Intensity )

Definition at line 815 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetAORadius()

void ASceneCaptureSensor::SetAORadius ( float Radius )

Definition at line 827 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetAperture()

void ASceneCaptureSensor::SetAperture ( float Aperture )

Definition at line 317 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor(), and ASceneCaptureCamera_RayTracedLens::Set().

◆ SetBladeCount()

void ASceneCaptureSensor::SetBladeCount ( int Count )

Definition at line 389 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetBloomConvolutionTexture()

void ASceneCaptureSensor::SetBloomConvolutionTexture ( UTexture2D * Texture )

Definition at line 245 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetBloomIntensity()

void ASceneCaptureSensor::SetBloomIntensity ( float Intensity )

Definition at line 575 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetBloomMethod()

void ASceneCaptureSensor::SetBloomMethod ( EBloomMethod Method )

Definition at line 569 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetBlueCorrection()

void ASceneCaptureSensor::SetBlueCorrection ( float Val )

Definition at line 779 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetChromAberrIntensity()

void ASceneCaptureSensor::SetChromAberrIntensity ( float Intensity )

Definition at line 611 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetChromAberrOffset()

void ASceneCaptureSensor::SetChromAberrOffset ( float ChromAberrOffset )

Definition at line 623 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetColorContrast()

void ASceneCaptureSensor::SetColorContrast ( FVector4 ColorContrast )

Definition at line 671 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetColorContrastHighlights()

void ASceneCaptureSensor::SetColorContrastHighlights ( FVector4 ColorContrast )

Definition at line 695 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetColorContrastMidtones()

void ASceneCaptureSensor::SetColorContrastMidtones ( FVector4 ColorContrast )

Definition at line 683 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetColorGamma()

void ASceneCaptureSensor::SetColorGamma ( FVector4 ColorGamma )

Definition at line 707 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetColorSaturation()

void ASceneCaptureSensor::SetColorSaturation ( FVector4 ColorSaturation )

Definition at line 635 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetColorSaturationHighlights()

void ASceneCaptureSensor::SetColorSaturationHighlights ( FVector4 ColorSaturation )

Definition at line 659 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetColorSaturationMidtones()

void ASceneCaptureSensor::SetColorSaturationMidtones ( FVector4 ColorSaturation )

Definition at line 647 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetDepthBlurAmount()

void ASceneCaptureSensor::SetDepthBlurAmount ( float Amount )

Definition at line 353 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetDepthBlurRadius()

void ASceneCaptureSensor::SetDepthBlurRadius ( float Radius )

Definition at line 365 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetDepthOfFieldMinFstop()

void ASceneCaptureSensor::SetDepthOfFieldMinFstop ( float MinFstop )

Definition at line 377 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetDetailStrength()

void ASceneCaptureSensor::SetDetailStrength ( float Val )

Definition at line 791 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetDirtMaskIntensity()

void ASceneCaptureSensor::SetDirtMaskIntensity ( float Intensity )

Definition at line 251 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetDLSSUpscale()

void ASceneCaptureSensor::SetDLSSUpscale	(	bool	Enable,
		float	ScreenPercentage
	)

inline

Render the capture at ScreenPercentage (25-100) of the target resolution and upscale it back with DLSS Super Resolution when available (bilinear otherwise).

100 or Enable=false keeps the stock full-resolution path.

Definition at line 170 of file SceneCaptureSensor.h.

Referenced by UActorBlueprintFunctionLibrary::SetCamera().

◆ SetExposureCalibrationConstant()

void ASceneCaptureSensor::SetExposureCalibrationConstant ( float Constant )

Definition at line 509 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetExposureCompensation()

void ASceneCaptureSensor::SetExposureCompensation ( float Compensation )

Definition at line 275 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetExposureMaxBrightness()

void ASceneCaptureSensor::SetExposureMaxBrightness ( float Brightness )

Definition at line 473 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetExposureMethod()

void ASceneCaptureSensor::SetExposureMethod ( EAutoExposureMethod Method )

Definition at line 227 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetExposureMinBrightness()

void ASceneCaptureSensor::SetExposureMinBrightness ( float Brightness )

Definition at line 461 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetExposureSpeedDown()

void ASceneCaptureSensor::SetExposureSpeedDown ( float Speed )

Definition at line 485 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetExposureSpeedUp()

void ASceneCaptureSensor::SetExposureSpeedUp ( float Speed )

Definition at line 497 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFilmBlackClip()

void ASceneCaptureSensor::SetFilmBlackClip ( float BlackClip )

Definition at line 437 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFilmGrainIntensity()

void ASceneCaptureSensor::SetFilmGrainIntensity ( float Val )

Definition at line 803 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFilmShoulder()

void ASceneCaptureSensor::SetFilmShoulder ( float Shoulder )

Definition at line 425 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFilmSlope()

void ASceneCaptureSensor::SetFilmSlope ( float Slope )

Definition at line 401 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFilmToe()

void ASceneCaptureSensor::SetFilmToe ( float Toe )

Definition at line 413 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFilmWhiteClip()

void ASceneCaptureSensor::SetFilmWhiteClip ( float WhiteClip )

Definition at line 449 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetFocalDistance()

void ASceneCaptureSensor::SetFocalDistance ( float Distance )

Definition at line 341 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ASceneCaptureCamera_RayTracedLensDistance::ApplyDistanceAOVConfig(), ASceneCaptureCamera_RayTracedLensInstance::ApplyInstanceAOVConfig(), ApplyPostProcessVolumeToSensor(), and ASceneCaptureCamera_RayTracedLens::Set().

◆ SetFOVAngle()

void ASceneCaptureSensor::SetFOVAngle ( float FOVAngle )

Definition at line 209 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by UActorBlueprintFunctionLibrary::SetCamera().

◆ SetGlobalGain()

void ASceneCaptureSensor::SetGlobalGain ( FVector4 Gain )

Definition at line 767 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetHighlightContrastScale()

void ASceneCaptureSensor::SetHighlightContrastScale ( float HighlightContrastScale )

Definition at line 839 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetHighlightsGamma()

void ASceneCaptureSensor::SetHighlightsGamma ( FVector4 HighlightsGamma )

Definition at line 719 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetImageSize()

void ASceneCaptureSensor::SetImageSize	(	uint32	Width,
		uint32	Height
	)

Definition at line 178 of file SceneCaptureSensor.cpp.

References ImageHeight, and ImageWidth.

Referenced by UActorBlueprintFunctionLibrary::SetCamera().

◆ SetISO()

void ASceneCaptureSensor::SetISO ( float ISO )

Definition at line 305 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetLensFlareIntensity()

void ASceneCaptureSensor::SetLensFlareIntensity ( float Intensity )

Definition at line 557 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetLocalExposureMethod()

void ASceneCaptureSensor::SetLocalExposureMethod ( ELocalExposureMethod Method )

Definition at line 233 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetMotionBlurIntensity()

void ASceneCaptureSensor::SetMotionBlurIntensity ( float Intensity )

Definition at line 521 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetMotionBlurMaxDistortion()

void ASceneCaptureSensor::SetMotionBlurMaxDistortion ( float MaxDistortion )

Definition at line 533 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetMotionBlurMinObjectScreenSize()

void ASceneCaptureSensor::SetMotionBlurMinObjectScreenSize ( float ScreenSize )

Definition at line 545 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetSceneColorTint()

void ASceneCaptureSensor::SetSceneColorTint ( FLinearColor SceneColorTint )

Definition at line 743 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetSensorWidth()

void ASceneCaptureSensor::SetSensorWidth ( float Width )

Definition at line 329 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetShadowCatcherTags()

void ASceneCaptureSensor::SetShadowCatcherTags ( const FString & CommaSeparatedLabels )

inline

Labels whose actors are rendered alongside the show-only set so they receive its cast shadows ("Roads,Sidewalks").

No effect when the show-only mode is off.

Definition at line 209 of file SceneCaptureSensor.h.

◆ SetShadowContrastScale()

void ASceneCaptureSensor::SetShadowContrastScale ( float ShadowContrastScale )

Definition at line 851 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetShowOnlyActorIds()

void ASceneCaptureSensor::SetShowOnlyActorIds ( const FString & CommaSeparatedIds )

inline

CARLA actor ids always included in the show-only set.

Definition at line 216 of file SceneCaptureSensor.h.

◆ SetShowOnlyTags()

void ASceneCaptureSensor::SetShowOnlyTags ( const FString & CommaSeparatedLabels )

inline

Show-only render mode (see FCarlaShowOnlyFilter): comma separated semantic label names.

Non-empty restricts the capture to the actors carrying those labels (plus the shadow catchers and explicit ids).

Definition at line 200 of file SceneCaptureSensor.h.

◆ SetShutterSpeed()

void ASceneCaptureSensor::SetShutterSpeed ( float Speed )

Definition at line 293 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetTargetGamma()

void ASceneCaptureSensor::SetTargetGamma ( float InTargetGamma )

inline

Definition at line 251 of file SceneCaptureSensor.h.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetToneCurveAmount()

void ASceneCaptureSensor::SetToneCurveAmount ( float ToneCurveAmount )

Definition at line 731 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetUpSceneCaptureComponent()

virtual void ASceneCaptureSensor::SetUpSceneCaptureComponent ( USceneCaptureComponent2D & SceneCapture )

inlineprotectedvirtual

Reimplemented in AInstanceSegmentationCamera, ASemanticSegmentationCamera, and AShaderBasedSensor.

Definition at line 676 of file SceneCaptureSensor.h.

Referenced by BeginPlay().

◆ SetUseRayTracing()

void ASceneCaptureSensor::SetUseRayTracing ( bool Enable )

Definition at line 184 of file SceneCaptureSensor.cpp.

References ApplyRayTracingSetting(), and bUseRayTracing.

Referenced by ASceneCaptureCamera_RayTracedLens::ASceneCaptureCamera_RayTracedLens(), and UActorBlueprintFunctionLibrary::SetCamera().

◆ SetVignetteIntensity()

void ASceneCaptureSensor::SetVignetteIntensity ( float VignetteIntensity )

Definition at line 755 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

◆ SetWhiteTemp()

void ASceneCaptureSensor::SetWhiteTemp ( float Temp )

Definition at line 587 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ SetWhiteTint()

void ASceneCaptureSensor::SetWhiteTint ( float Tint )

Definition at line 599 of file SceneCaptureSensor.cpp.

References CaptureComponent2D.

Referenced by ApplyPostProcessVolumeToSensor().

◆ ShouldCaptureThisFrame()

bool ASceneCaptureSensor::ShouldCaptureThisFrame ( )

protected

Aggregate gate: main stream or any GBuffer stream has listeners, or CVarCarlaCameraForceAllGBuffers forces every frame.

Non-const because ASensor::AreClientsListening() is non-const.

Definition at line 1149 of file SceneCaptureSensor.cpp.

References ASensor::AreClientsListening(), CVarCarlaCameraForceAllGBuffers(), and IsAnyGBufferClientListening().

Referenced by PostPhysTick(), PrePhysTick(), and ASceneCaptureCamera_RayTracedLens::TickCaptureAndReadback().

◆ UpdateExposureMotionBlur()

void ASceneCaptureSensor::UpdateExposureMotionBlur	(	UWorld *	World,
		float	DeltaTime
	)

protected

Motion blur from the auto exposure time (carla.Camera.ExposureMotionBlur).

Definition at line 1198 of file SceneCaptureSensor.cpp.

References ArePostProcessingEffectsEnabled(), CaptureComponent2D, CVarCarlaCameraExposureLog(), CVarCarlaCameraExposureMotionBlur(), CVarCarlaCameraFNumber(), CVarCarlaCameraMaxExposureMs(), CVarCarlaCameraMinExposureMs(), ExposureSeconds, and LastCaptureTime.

Referenced by PostPhysTick().

◆ UpdatePostProcessConfig()

void ASceneCaptureSensor::UpdatePostProcessConfig ( FPostProcessConfig & InOutPostProcessConfig )

virtual

Reimplemented in ASceneCaptureCamera_RayTracedLens.

Definition at line 863 of file SceneCaptureSensor.cpp.

Referenced by BeginPlay().

◆ WaitForRenderThreadToFinish()

void ASceneCaptureSensor::WaitForRenderThreadToFinish ( )

inline

Blocks until the render thread has finished all it's tasks.

Definition at line 620 of file SceneCaptureSensor.h.

References WaitForRenderThreadToFinish().

Referenced by ADVSCamera::PostPhysTick(), and WaitForRenderThreadToFinish().

Friends And Related Symbol Documentation

◆ ACarlaGameModeBase

friend class ACarlaGameModeBase

friend

Definition at line 128 of file SceneCaptureSensor.h.

◆ FPixelReader

friend class FPixelReader

friend

Definition at line 129 of file SceneCaptureSensor.h.

◆ FPixelReader2

friend class FPixelReader2

friend

Definition at line 130 of file SceneCaptureSensor.h.

Member Data Documentation

◆ bEnable16BitFormat

bool ASceneCaptureSensor::bEnable16BitFormat = false

protected

Whether to change render target format to PF_A16B16G16R16, offering 16bit / channel.

Definition at line 720 of file SceneCaptureSensor.h.

Referenced by BeginPlay().

◆ bEnableDLSSUpscale

bool ASceneCaptureSensor::bEnableDLSSUpscale = false

protected

Render the capture at DLSSScreenPercentage of the target resolution and upscale back with DLSS Super Resolution (engine scene-capture temporal upscaler; bilinear fallback without NVIDIA hardware).

Off by default: non-NVIDIA users keep the stock full-resolution path. Requires bEnablePostProcessingEffects (the capture needs a temporal AA method for DLSS to engage; without one the engine spatially upscales instead).

Definition at line 729 of file SceneCaptureSensor.h.

Referenced by BeginPlay().

◆ bEnablePostProcessingEffects

bool ASceneCaptureSensor::bEnablePostProcessingEffects = true

protected

Whether to render the post-processing effects present in the scene.

Definition at line 707 of file SceneCaptureSensor.h.

Referenced by BeginPlay().

◆ bUseRayTracing

bool ASceneCaptureSensor::bUseRayTracing = true

protected

Whether this sensor uses hardware ray tracing for its scene capture.

Defaults to true so cameras follow upstream behaviour out of the box. Setting false saves ~700 MiB-1 GiB on the GPU and is intended for sensors that do not need RT (depth, semantic, lidar). The global CVar carla.Camera.UseRayTracing forces on/off across every camera regardless of the per-sensor attribute.

Definition at line 716 of file SceneCaptureSensor.h.

Referenced by ApplyRayTracingSetting(), and SetUseRayTracing().

◆ [struct]

struct { ... } ASceneCaptureSensor::CameraGBuffers

Referenced by FCarlaServer::FPimpl::BindActions(), and IsAnyGBufferClientListening().

◆ CaptureComponent2D

TObjectPtr<USceneCaptureComponent2D_CARLA> ASceneCaptureSensor::CaptureComponent2D = nullptr

protected

Scene capture component.

Definition at line 684 of file SceneCaptureSensor.h.

◆ CaptureRenderTarget

TObjectPtr<UTextureRenderTarget2D> ASceneCaptureSensor::CaptureRenderTarget = nullptr

protected

Render target necessary for scene capture.

Definition at line 680 of file SceneCaptureSensor.h.

Referenced by ASceneCaptureSensor(), BeginPlay(), EndPlay(), and ADVSCamera::PostPhysTick().

◆ CustomDepth

FCameraGBufferUint8 ASceneCaptureSensor::CustomDepth

Definition at line 639 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ CustomStencil

FCameraGBufferUint8 ASceneCaptureSensor::CustomStencil

Definition at line 640 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ DLSSScreenPercentage

float ASceneCaptureSensor::DLSSScreenPercentage = 50.0f

protected

Internal render resolution as a percentage of the target resolution when bEnableDLSSUpscale is set.

50 = quarter of the pixels, 33 = one ninth.

Definition at line 734 of file SceneCaptureSensor.h.

Referenced by BeginPlay().

◆ ExposureSeconds

float ASceneCaptureSensor::ExposureSeconds = 0.0f

protected

Exposure time of the last capture in seconds (exposure-linked motion blur).

Definition at line 672 of file SceneCaptureSensor.h.

Referenced by UpdateExposureMotionBlur().

◆ GBufferA

FCameraGBufferUint8 ASceneCaptureSensor::GBufferA

Definition at line 631 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ GBufferB

FCameraGBufferUint8 ASceneCaptureSensor::GBufferB

Definition at line 632 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ GBufferC

FCameraGBufferUint8 ASceneCaptureSensor::GBufferC

Definition at line 633 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ GBufferD

FCameraGBufferUint8 ASceneCaptureSensor::GBufferD

Definition at line 634 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ GBufferE

FCameraGBufferUint8 ASceneCaptureSensor::GBufferE

Definition at line 635 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ GBufferF

FCameraGBufferUint8 ASceneCaptureSensor::GBufferF

Definition at line 636 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ ImageHeight

uint32 ASceneCaptureSensor::ImageHeight = 600u

protected

Image height in pixels.

Definition at line 703 of file SceneCaptureSensor.h.

Referenced by BeginPlay(), and SetImageSize().

◆ ImageWidth

uint32 ASceneCaptureSensor::ImageWidth = 800u

protected

Image width in pixels.

Definition at line 699 of file SceneCaptureSensor.h.

Referenced by BeginPlay(), PrePhysTick(), and SetImageSize().

◆ LastCaptureTime

double ASceneCaptureSensor::LastCaptureTime = -1.0

protected

Simulation time of this sensor's previous capture (-1 before the first).

Definition at line 669 of file SceneCaptureSensor.h.

Referenced by UpdateExposureMotionBlur().

◆ NumCaptures

int32 ASceneCaptureSensor::NumCaptures = 0

private

Captures rendered as camera cuts since BeginPlay (carla.Camera.SpawnCameraCuts).

Definition at line 757 of file SceneCaptureSensor.h.

Referenced by EnqueueRenderSceneImmediate().

◆ ReadbackPool

FRHIGPUReadbackPoolPtr ASceneCaptureSensor::ReadbackPool

protected

Per-sensor pool of recyclable RHI readback objects.

Created in BeginPlay, dropped in EndPlay; outstanding AsyncTasks keep it alive via shared ownership.

Definition at line 739 of file SceneCaptureSensor.h.

Referenced by BeginPlay(), and EndPlay().

◆ SceneColor

FCameraGBufferUint8 ASceneCaptureSensor::SceneColor

Definition at line 628 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ SceneDepth

FCameraGBufferUint8 ASceneCaptureSensor::SceneDepth

Definition at line 629 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ SceneStencil

FCameraGBufferUint8 ASceneCaptureSensor::SceneStencil

Definition at line 630 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ ShowOnlyFilter

FCarlaShowOnlyFilter ASceneCaptureSensor::ShowOnlyFilter

protected

Show-only actor filter, applied to the capture component right before every capture (see FCarlaShowOnlyFilter).

Definition at line 743 of file SceneCaptureSensor.h.

Referenced by EnqueueRenderSceneImmediate().

◆ SSAO

FCameraGBufferUint8 ASceneCaptureSensor::SSAO

Definition at line 638 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

◆ TargetGamma

float ASceneCaptureSensor::TargetGamma = 2.2f

protected

Definition at line 695 of file SceneCaptureSensor.h.

Referenced by BeginPlay().

◆ Velocity

FCameraGBufferUint8 ASceneCaptureSensor::Velocity

Definition at line 637 of file SceneCaptureSensor.h.

Referenced by FCarlaServer::FPimpl::BindActions().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ASceneCaptureSensor()

Member Function Documentation

◆ ApplyPostProcessVolumeToSensor()

◆ ApplyRayTracingSetting()

◆ ArePostProcessingEffectsEnabled()

◆ BeginPlay()

◆ CaptureSceneExtended()

◆ Enable16BitFormat()

◆ EnablePostProcessingEffects()

◆ EndPlay()

◆ EnqueueRenderSceneImmediate()

◆ GetAOIntensity()

◆ GetAORadius()

◆ GetAperture()

◆ GetBladeCount()

◆ GetBloomIntensity()

◆ GetBloomKernelTexture()

◆ GetBloomMethod()

◆ GetBlueCorrection()

◆ GetCaptureComponent()

◆ GetCaptureComponent2D()

◆ GetCaptureRenderTarget()

◆ GetChromAberrIntensity()

◆ GetChromAberrOffset()

◆ GetColorContrast()

◆ GetColorContrastHighlights()

◆ GetColorContrastMidtones()

◆ GetColorGamma()

◆ GetColorSaturation()

◆ GetColorSaturationHighlights()

◆ GetColorSaturationMidtones()

◆ GetDepthBlurAmount()

◆ GetDepthBlurRadius()

◆ GetDepthOfFieldMinFstop()

◆ GetDetailStrength()

◆ GetDirtMaskIntensity()

◆ GetExposureCalibrationConstant()

◆ GetExposureCompensation()

◆ GetExposureMaxBrightness()

◆ GetExposureMethod()

◆ GetExposureMinBrightness()

◆ GetExposureSpeedDown()

◆ GetExposureSpeedUp()

◆ GetFilmBlackClip()

◆ GetFilmGrainIntensity()

◆ GetFilmShoulder()

◆ GetFilmSlope()

◆ GetFilmToe()

◆ GetFilmWhiteClip()

◆ GetFocalDistance()

◆ GetFOVAngle()

◆ GetGlobalGain()

◆ GetHighlightContrastScale()

◆ GetHighlightsGamma()

◆ GetImageHeight()

◆ GetImageWidth()

◆ GetISO()

◆ GetLensFlareIntensity()

◆ GetLocalExposureMethod()

◆ GetMotionBlurIntensity()

◆ GetMotionBlurMaxDistortion()

◆ GetMotionBlurMinObjectScreenSize()

◆ GetReadbackPool()

◆ GetSceneColorTint()

◆ GetSensorWidth()

◆ GetShadowContrastScale()

◆ GetShowOnlyFilter()

◆ GetShutterSpeed()

◆ GetTargetGamma()