Loads a bitmap content from chunk. More...

#include <bitmap_from_chunk.h>

Inheritance diagram for Beatmup::BitmapFromChunk:

Public Member Functions
	BitmapFromChunk ()

	BitmapFromChunk (AbstractBitmap &bitmap, ChunkCollection &collection, const std::string &chunkId)

void	setBitmap (AbstractBitmap *bitmap)

void	setCollection (ChunkCollection *collection)

void	setChunkId (const std::string &chunkId)

Public Member Functions inherited from Beatmup::AbstractTask
virtual bool	processOnGPU (GraphicPipeline &gpu, TaskThread &thread)
	Executes the task on GPU. More...

virtual TaskDeviceRequirement	getUsedDevices () const
	Communicates devices (CPU and/or GPU) the task is run on. More...

virtual ThreadIndex	getMaxThreads () const
	Gives the upper limint on the number of threads the task may be performed by. More...

Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Public Member Functions inherited from Beatmup::BitmapContentLock
	BitmapContentLock ()

	~BitmapContentLock ()

void	readLock (GraphicPipeline gpu, AbstractBitmap bitmap, ProcessingTarget target)
	Locks content of a bitmap for reading using a specific processing target device. More...

void	writeLock (GraphicPipeline gpu, AbstractBitmap bitmap, ProcessingTarget target)
	Locks content of a bitmap for writing using a specific processing target device. More...

void	unlock (AbstractBitmap *bitmap)
	Drops a lock to the bitmap. More...

void	unlockAll ()
	Unlocks all the locked bitmaps unconditionally. More...

template<const ProcessingTarget target>
void	lock (GraphicPipeline gpu, AbstractBitmap input, AbstractBitmap *output)

void	lock (GraphicPipeline gpu, ProcessingTarget target, AbstractBitmap input, AbstractBitmap *output)

template<const ProcessingTarget target>
void	lock (GraphicPipeline gpu, std::initializer_list< AbstractBitmap > read, std::initializer_list< AbstractBitmap * > write)

template<typename ... Args>
void	unlock (AbstractBitmap *first, Args ... others)

Static Public Member Functions
static void	load (AbstractBitmap &bitmap, ChunkCollection &collection, const std::string &chunkId)
	Loads a bitmap content from a given collection and chunk. More...

Static Public Member Functions inherited from Beatmup::AbstractTask
static ThreadIndex	validThreadCount (int number)
	Valid thread count from a given integer value. More...

Private Member Functions
virtual bool	process (TaskThread &thread)
	Executes the task on CPU within a given thread. More...

virtual void	beforeProcessing (ThreadIndex threadCount, ProcessingTarget target, GraphicPipeline *gpu)
	Instruction called before the task is executed. More...

virtual void	afterProcessing (ThreadIndex threadCount, GraphicPipeline *gpu, bool aborted)
	Instruction called after the task is executed. More...

Private Attributes
AbstractBitmap *	bitmap

ChunkCollection *	collection

std::string	chunkId

Additional Inherited Members
Public Types inherited from Beatmup::AbstractTask
enum class	TaskDeviceRequirement { CPU_ONLY , GPU_OR_CPU , GPU_ONLY }
	Specifies which device (CPU and/or GPU) is used to run the task. More...

Detailed Description

Loads a bitmap content from chunk.

The bitmap needs to be created in advance. The loaded chunk contains pixel data in binary form.

Definition at line 31 of file bitmap_from_chunk.h.

Constructor & Destructor Documentation

◆ BitmapFromChunk() [1/2]

Beatmup::BitmapFromChunk::BitmapFromChunk ( )

inline

Definition at line 40 of file bitmap_from_chunk.h.

40 : bitmap(nullptr), collection(nullptr) {}

Beatmup::BitmapFromChunk::bitmap

AbstractBitmap * bitmap

Definition: bitmap_from_chunk.h:36

Beatmup::BitmapFromChunk::collection

ChunkCollection * collection

Definition: bitmap_from_chunk.h:37

◆ BitmapFromChunk() [2/2]

Beatmup::BitmapFromChunk::BitmapFromChunk	(	AbstractBitmap &	bitmap,
		ChunkCollection &	collection,
		const std::string &	chunkId
	)

inline

Definition at line 41 of file bitmap_from_chunk.h.

41 :

42 bitmap(&bitmap), collection(&collection), chunkId(chunkId) {}

Beatmup::BitmapFromChunk::chunkId

std::string chunkId

Definition: bitmap_from_chunk.h:38

Member Function Documentation

◆ process()

bool BitmapFromChunk::process ( TaskThread & thread )

privatevirtual

Executes the task on CPU within a given thread.

Generally called by multiple threads.

Parameters

thread associated task execution context

Returns: true if the execution is finished correctly, false otherwise

Implements Beatmup::AbstractTask.

Definition at line 23 of file bitmap_from_chunk.cpp.

                                                 {
     collection->fetch(chunkId, bitmap->getData(0, 0), bitmap->getMemorySize());
     return true;
 }

◆ beforeProcessing()

void BitmapFromChunk::beforeProcessing	(	ThreadIndex	threadCount,
		ProcessingTarget	target,
		GraphicPipeline *	gpu
	)

privatevirtual

Instruction called before the task is executed.

Parameters

threadCount	Number of threads used to perform the task
target	Device used to perform the task
gpu	A graphic pipeline instance; may be null.

Reimplemented from Beatmup::AbstractTask.

Definition at line 29 of file bitmap_from_chunk.cpp.

                                                                                                              {
     NullTaskInput::check(bitmap, "bitmap");
     NullTaskInput::check(collection, "chunk collection");
     InvalidArgument::check(collection->chunkExists(chunkId), "Chunk not found: " + chunkId);
     const size_t chunkSize = collection->chunkSize(chunkId);
     const size_t bitmapSize = bitmap->getMemorySize();
     InvalidArgument::check(chunkSize == bitmapSize,
         "Chunk size does not match bitmap size: " + std::to_string(chunkSize) + " vs "  + std::to_string(bitmapSize) + " bytes");
     writeLock(gpu, bitmap, ProcessingTarget::CPU);
 }

◆ afterProcessing()

void BitmapFromChunk::afterProcessing	(	ThreadIndex	threadCount,
		GraphicPipeline *	gpu,
		bool	aborted
	)

privatevirtual

Instruction called after the task is executed.

Parameters

threadCount	Number of threads used to perform the task
gpu	GPU to be used to execute the task; may be null.
aborted	`true` if the task was aborted

Reimplemented from Beatmup::AbstractTask.

Definition at line 41 of file bitmap_from_chunk.cpp.

                                                                                                  {
     unlock(bitmap);
 }

◆ setBitmap()

void Beatmup::BitmapFromChunk::setBitmap ( AbstractBitmap * bitmap )

inline

Definition at line 44 of file bitmap_from_chunk.h.

44 { this->bitmap = bitmap; }

◆ setCollection()

void Beatmup::BitmapFromChunk::setCollection ( ChunkCollection * collection )

inline

Definition at line 46 of file bitmap_from_chunk.h.

46 { this->collection = collection; }

◆ setChunkId()

void Beatmup::BitmapFromChunk::setChunkId ( const std::string & chunkId )

inline

Definition at line 48 of file bitmap_from_chunk.h.

48 { this->chunkId = chunkId; }

◆ load()

void BitmapFromChunk::load	(	AbstractBitmap &	bitmap,
		ChunkCollection &	collection,
		const std::string &	chunkId
	)

static

Loads a bitmap content from a given collection and chunk.

Launches a task in the main thread pool of the bitmap context.

Parameters

[in,out]	bitmap	The bitmap to load
[in,out]	collection	The collection to load from
[in,out]	chunkId	Chunk ID containing the content to load

Definition at line 46 of file bitmap_from_chunk.cpp.

                                                                                                         {
     BitmapFromChunk task(bitmap, collection, chunkId);
     bitmap.getContext().performTask(task);
 }

Member Data Documentation

◆ bitmap

AbstractBitmap* Beatmup::BitmapFromChunk::bitmap

private

Definition at line 36 of file bitmap_from_chunk.h.

◆ collection

ChunkCollection* Beatmup::BitmapFromChunk::collection

private

Definition at line 37 of file bitmap_from_chunk.h.

◆ chunkId

std::string Beatmup::BitmapFromChunk::chunkId

private

Definition at line 38 of file bitmap_from_chunk.h.

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

core/utils/bitmap_from_chunk.h
core/utils/bitmap_from_chunk.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BitmapFromChunk() [1/2]

◆ BitmapFromChunk() [2/2]

Member Function Documentation

◆ process()

◆ beforeProcessing()

◆ afterProcessing()

◆ setBitmap()

◆ setCollection()

◆ setChunkId()

◆ load()

Member Data Documentation

◆ bitmap

◆ collection

◆ chunkId