FPixelReader Class Reference

Utils for reading pixels from UTextureRenderTarget2D. More...

#include <PixelReader.h>

Public Types
using	Payload = std::function< void(void *, uint32, uint32, uint32)>

Static Public Member Functions
static TUniquePtr< TImagePixelData< FColor > >	DumpPixels (UTextureRenderTarget2D &RenderTarget)
	Dump the pixels in RenderTarget.
static TFuture< bool >	SavePixelsToDisk (TUniquePtr< TImagePixelData< FColor > > PixelData, const FString &FilePath)
	Asynchronously save the pixels in PixelData to disk.
static TFuture< bool >	SavePixelsToDisk (UTextureRenderTarget2D &RenderTarget, const FString &FilePath)
	Asynchronously save the pixels in RenderTarget to disk.
template<typename TSensor , typename TPixel >
static void	SendPixelsInRenderThread (TSensor &Sensor, bool use16BitFormat=false, std::function< TArray< TPixel >(void *, uint32)> Conversor={})
	Convenience function to enqueue a render command that sends the pixels down the Sensor's data stream.
static bool	WritePixelsToArray (UTextureRenderTarget2D &RenderTarget, TArray< FColor > &BitMap)
	Copy the pixels in RenderTarget into BitMap.
static void	WritePixelsToBuffer (UTextureRenderTarget2D &RenderTarget, uint32 Offset, FRHICommandListImmediate &InRHICmdList, FPixelReader::Payload FuncForSending, FRHIGPUReadbackPoolPtr Pool=nullptr)
	Copy the pixels in RenderTarget into Buffer.

Detailed Description

Utils for reading pixels from UTextureRenderTarget2D.

Todo:

This class only supports PF_R8G8B8A8 format.

Definition at line 41 of file PixelReader.h.

Member Typedef Documentation

Payload

using FPixelReader::Payload = std::function<void(void *, uint32, uint32, uint32)>

Definition at line 45 of file PixelReader.h.

Member Function Documentation

DumpPixels()

TUniquePtr< TImagePixelData< FColor > > FPixelReader::DumpPixels ( UTextureRenderTarget2D &  RenderTarget )

static

Dump the pixels in RenderTarget.

Precondition

To be called from game-thread.

Definition at line 172 of file PixelReader.cpp.

References WritePixelsToArray().

Referenced by SavePixelsToDisk().

SavePixelsToDisk() [1/2]

TFuture< bool > FPixelReader::SavePixelsToDisk ( TUniquePtr< TImagePixelData< FColor > >  PixelData, const FString &  FilePath  )

static

Asynchronously save the pixels in PixelData to disk.

Precondition

To be called from game-thread.

Definition at line 193 of file PixelReader.cpp.

SavePixelsToDisk() [2/2]

TFuture< bool > FPixelReader::SavePixelsToDisk ( UTextureRenderTarget2D &  RenderTarget, const FString &  FilePath  )

static

Asynchronously save the pixels in RenderTarget to disk.

Precondition

To be called from game-thread.

Definition at line 186 of file PixelReader.cpp.

References DumpPixels(), and SavePixelsToDisk().

Referenced by ASceneCaptureSensor_WideAngleLens::CaptureSceneExtended(), URoadMap::SaveAsPNG(), ASceneCaptureSensor::SaveCaptureToDisk(), and SavePixelsToDisk().

SendPixelsInRenderThread()

template<typename TSensor , typename TPixel >

void FPixelReader::SendPixelsInRenderThread ( TSensor &  Sensor, bool  use16BitFormat = false, std::function< TArray< TPixel >(void *, uint32)>  Conversor = {}  )

static

Convenience function to enqueue a render command that sends the pixels down the Sensor's data stream.

It expects a sensor derived from ASceneCaptureSensor or compatible.

Note that the serializer needs to define a "header_offset" that it's allocated in front of the buffer.

Precondition

To be called from game-thread.

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

Todo:

Can we make sure the sensor is not going to be destroyed?

Definition at line 104 of file PixelReader.h.

References carla::BufferView::CreateFrom(), carla::streaming::detail::token_type::get_stream_id(), FCarlaEngine::GetFrameCounter(), carla::ros2::ROS2::GetInstance(), SendPixelsInRenderThread(), carla::sensor::CompositeSerializer< Items >::Serialize(), and WritePixelsToBuffer().

Referenced by SendPixelsInRenderThread().

WritePixelsToArray()

bool FPixelReader::WritePixelsToArray ( UTextureRenderTarget2D &  RenderTarget, TArray< FColor > &  BitMap  )

static

Copy the pixels in RenderTarget into BitMap.

Precondition

To be called from game-thread.

Definition at line 155 of file PixelReader.cpp.

Referenced by DumpPixels(), and ASceneCaptureSensor::ReadPixels().

WritePixelsToBuffer()

void FPixelReader::WritePixelsToBuffer ( UTextureRenderTarget2D &  RenderTarget, uint32  Offset, FRHICommandListImmediate &  InRHICmdList, FPixelReader::Payload  FuncForSending, FRHIGPUReadbackPoolPtr  Pool = nullptr  )

static

Copy the pixels in RenderTarget into Buffer.

Precondition

To be called from render-thread.

Parameters

Pool	Optional per-sensor readback pool; when null falls back to a per-call alloc.

Definition at line 36 of file PixelReader.cpp.

References CVarPixelReaderLegacyVulkanFenceFlush().

Referenced by SendPixelsInRenderThread().

---

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

• PixelReader.h
• PixelReader.cpp