Beatmup::Crop Class Reference

A task to clip images on CPU. More...

#include <crop.h>

Inheritance diagram for Beatmup::Crop:

Public Member Functions
	Crop ()
ThreadIndex	getMaxThreads () const
	Gives the upper limint on the number of threads the task may be performed by. More...
void	setInput (AbstractBitmap *input)
void	setOutput (AbstractBitmap *output)
void	setCropRect (IntRectangle)
	Sets crop rectangle in input bitmap. More...
void	setOutputOrigin (IntPoint)
	Sets top-left position of the clip rectangle in output bitmap. More...
bool	isFit () const
	Checks if everything is fitted to make cropping. More...
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...
Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Static Public Member Functions
static AbstractBitmap *	run (AbstractBitmap &bitmap, IntRectangle clipRect)
	Copies out a specified rect of a bitmap into another bitmap. More...
Static Public Member Functions inherited from Beatmup::AbstractTask
static ThreadIndex	validThreadCount (int number)
	Valid thread count from a given integer value. More...

Protected Member Functions
virtual bool	process (TaskThread &)
	Executes the task on CPU within a given thread. More...
virtual void	beforeProcessing (ThreadIndex, ProcessingTarget target, GraphicPipeline *)
	Instruction called before the task is executed. More...
virtual void	afterProcessing (ThreadIndex, GraphicPipeline *, bool)
	Instruction called after the task is executed. More...

Private Attributes
AbstractBitmap *	input
AbstractBitmap *	output
	input and output bitmaps More...
IntPoint	outOrigin
	origin on output bitmap More...
IntRectangle	cropRect
	clip rect on input bitmap More...

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...
Private 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)

Detailed Description

A task to clip images on CPU.

Definition at line 29 of file crop.h.

Constructor & Destructor Documentation

Crop()

Crop::Crop

(

)

Definition at line 67 of file crop.cpp.

           : outOrigin(0, 0), cropRect(0, 0, 0, 0)
{}

Member Function Documentation

process()

bool Crop::process ( TaskThread &  thread )

protectedvirtual

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 71 of file crop.cpp.

                                     {
    BitmapProcessing::pipeline<Kernels::Cropping>(*input, *output, cropRect, outOrigin);
    return true;
}

beforeProcessing()

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

protectedvirtual

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 77 of file crop.cpp.

                                                                                                  {
    NullTaskInput::check(input, "input bitmap");
    NullTaskInput::check(output, "output bitmap");
    cropRect.normalize();
    if (!isFit()) {
        BEATMUP_DEBUG_E("Crop rectangle does not fit to bitmaps: ((%d,%d),(%d,%d)) from %d x %d to put at (%d,%d) in %d x %d.",
                cropRect.a.x, cropRect.b.x, cropRect.a.y, cropRect.b.y,
                input->getWidth(), input->getHeight(),
                outOrigin.x, outOrigin.y,
                output->getWidth(), output->getHeight());
        throw RuntimeError("Crop rectangle does not fit to bitmaps");
    }
    lock<ProcessingTarget::CPU>(gpu, input, output);
}

afterProcessing()

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

protectedvirtual

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 93 of file crop.cpp.

                                                                                      {
    unlock(input, output);
}

getMaxThreads()

ThreadIndex Beatmup::Crop::getMaxThreads ( ) const

inlinevirtual

Gives the upper limint on the number of threads the task may be performed by.

The actual number of threads running a specific task may be less or equal to the returned value, depending on the number of workers in ThreadPool running the task.

Reimplemented from Beatmup::AbstractTask.

Definition at line 41 of file crop.h.

{ return 1; }

setInput()

void Crop::setInput

(

AbstractBitmap *

input

)

Definition at line 98 of file crop.cpp.

                                         {
    this->input = input;
}

setOutput()

void Crop::setOutput

(

AbstractBitmap *

output

)

Definition at line 103 of file crop.cpp.

                                           {
    this->output = output;
}

setCropRect()

void Crop::setCropRect

(

IntRectangle

rect

)

Sets crop rectangle in input bitmap.

Definition at line 108 of file crop.cpp.

                                        {
    cropRect = rect;
}

setOutputOrigin()

void Crop::setOutputOrigin

(

IntPoint

pos

)

Sets top-left position of the clip rectangle in output bitmap.

Definition at line 113 of file crop.cpp.

                                       {
    outOrigin = pos;
}

isFit()

bool Crop::isFit

(

)

const

Checks if everything is fitted to make cropping.

Definition at line 118 of file crop.cpp.

                       {
    if (!input || !output)
        return false;
    if (!input->getSize().closedRectangle().isInside(cropRect.a))
        return false;
    IntPoint corner = cropRect.b - cropRect.a - 1 + outOrigin;
    if (!output->getSize().closedRectangle().isInside(corner))
        return false;
    return true;
}

run()

AbstractBitmap * Crop::run ( AbstractBitmap &  bitmap, IntRectangle  clipRect  )

static

Copies out a specified rect of a bitmap into another bitmap.

Definition at line 130 of file crop.cpp.

                                                                       {
    AbstractBitmap* out = new InternalBitmap(bitmap.getContext(), bitmap.getPixelFormat(), clipRect.width(), clipRect.height());
    // after byte-aligning out must be zeroed (not very optimal...)
    if (out->getSize().numPixels() != clipRect.getArea())
        out->zero();
    Crop clip;
    clip.setInput(&bitmap);
    clip.setOutput(out);
    clip.setCropRect(clipRect);
    bitmap.getContext().performTask(clip);
    return out;
}

Member Data Documentation

input

AbstractBitmap* Beatmup::Crop::input

private

Definition at line 31 of file crop.h.

output

AbstractBitmap * Beatmup::Crop::output

private

input and output bitmaps

Definition at line 31 of file crop.h.

outOrigin

IntPoint Beatmup::Crop::outOrigin

private

origin on output bitmap

Definition at line 32 of file crop.h.

cropRect

IntRectangle Beatmup::Crop::cropRect

private

clip rect on input bitmap

Definition at line 33 of file crop.h.

---

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

• core/bitmap/crop.h
• core/bitmap/crop.cpp