copies a part of the input buffer towards the current buffer. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Blit:

Public Member Functions
	Blit (TextureBufferPtr pBuffer)
	Default constructor. More...

Blit &	setInputBuffer (TextureBufferPtr inputBuffer)
	Sets the texture buffer that must be copied towards the current texture buffer. More...

Blit &	setInputRect (Ogre::RealRect rect, bool relative=true)
	Set the full rectangle coordinates of the input buffer to copy. More...

Blit &	setInputRect (Ogre::Rect rect)
	Set the full rectangle coordinates of the input buffer to copy. More...

Blit &	setInputRect (Ogre::Vector2 pos1, Ogre::Vector2 pos2, bool relative=true)
	Set the full rectangle coordinates of the input buffer to copy. More...

Blit &	setInputRect (size_t x1, size_t y1, size_t x2, size_t y2)
	Set the full rectangle coordinates of the input buffer to copy. More...

Blit &	setInputRect (Ogre::Real x1, Ogre::Real y1, Ogre::Real x2, Ogre::Real y2)
	Set the full rectangle coordinates of the input buffer to copy. More...

Blit &	setOutputRect (Ogre::RealRect rect, bool relative=true)
	Set the full rectangle coordinates of the output buffer where the input is copied to. More...

Blit &	setOutputRect (Ogre::Rect rect)
	Set the full rectangle coordinates of the output buffer where the input is copied to. More...

Blit &	setOutputRect (Ogre::Vector2 pos1, Ogre::Vector2 pos2, bool relative=true)
	Set the full rectangle coordinates of the output buffer where the input is copied to. More...

Blit &	setOutputRect (size_t x1, size_t y1, size_t x2, size_t y2)
	Set the full rectangle coordinates of the output buffer where the input is copied to. More...

Blit &	setOutputRect (Ogre::Real x1, Ogre::Real y1, Ogre::Real x2, Ogre::Real y2)
	Set the full rectangle coordinates of the output buffer where the input is copied to. More...

TextureBufferPtr	process ()
	Run image manipulation. More...

Ogre::String	getName ()
	Get name of the filter as string. More...

void	setLog (bool enable=true)
	Enable/Disable logging. More...

Protected Member Functions
void	logMsg (Ogre::String msg)

Protected Attributes
TextureBufferPtr	mBuffer

Ogre::String	mName

bool	mLog

Detailed Description

copies a part of the input buffer towards the current buffer.

Example:

Procedural::TextureBuffer bufferImage(256);
Procedural::Image(&bufferImage).setFile("red_brick.jpg").process();
 
Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).setColours(Ogre::ColourValue::Black, Ogre::ColourValue::Red, Ogre::ColourValue::Green, Ogre::ColourValue::Blue).process();
 
Procedural::Blit(&bufferImage).setInputBuffer(&bufferGradient).setInputRect(0.0f, 0.0f, 0.5f, 0.5f).setOutputRect(0.25f, 0.25f, 0.75f, 0.75f).process();

Constructor & Destructor Documentation

◆ Blit()

Procedural::Blit::Blit ( TextureBufferPtr pBuffer )

Default constructor.

Parameters

pBuffer Image buffer where to modify the image.

References TRect< long >::bottom, Procedural::TextureBuffer::getHeight(), Procedural::TextureBuffer::getWidth(), TRect< long >::left, TRect< long >::right, and TRect< long >::top.

Member Function Documentation

◆ getName()

Ogre::String Procedural::TextureProcessing::getName ( )

inherited

Get name of the filter as string.

◆ logMsg()

void Procedural::TextureProcessing::logMsg ( Ogre::String msg )

protectedinherited

◆ process()

TextureBufferPtr Procedural::Blit::process ( )

virtual

Run image manipulation.

Returns: Pointer to image buffer which has been set in the constructor.

Implements Procedural::TextureProcessing.

◆ setInputBuffer()

Blit& Procedural::Blit::setInputBuffer ( TextureBufferPtr inputBuffer )

Sets the texture buffer that must be copied towards the current texture buffer.

Parameters

inputBuffer Pointer on image where to copy from

◆ setInputRect() [1/5]

Blit& Procedural::Blit::setInputRect	(	Ogre::Real	x1,
		Ogre::Real	y1,
		Ogre::Real	x2,
		Ogre::Real	y2
	)

Set the full rectangle coordinates of the input buffer to copy.

Parameters

x1	New relative x position of rectangle start [0.0, 1.0] (default 0.0)
y1	New relative y position of rectangle start [0.0, 1.0] (default 0.0)
x2	New relative x position of rectangle end [0.0, 1.0] (default 1.0)
y2	New relative y position of rectangle end [0.0, 1.0] (default 1.0)

◆ setInputRect() [2/5]

Blit& Procedural::Blit::setInputRect	(	Ogre::RealRect	rect,
		bool	relative = `true`
	)

Set the full rectangle coordinates of the input buffer to copy.

Parameters

rect	Full rectangle description (default: left=0.0, top=0.0, right=1.0, bottom=1.0)
relative	If this is set to true (default) the rectangle data are relative [0.0, 1.0]; else absolut [px]

◆ setInputRect() [3/5]

Blit& Procedural::Blit::setInputRect ( Ogre::Rect rect )

Set the full rectangle coordinates of the input buffer to copy.

Parameters

rect	Full absolute rectangle description (default: left=0, top=0, right=image width, bottom=image height)

◆ setInputRect() [4/5]

Blit& Procedural::Blit::setInputRect	(	Ogre::Vector2	pos1,
		Ogre::Vector2	pos2,
		bool	relative = `true`
	)

Set the full rectangle coordinates of the input buffer to copy.

Parameters

pos1	Vector to top left start point of the rectangle (default: x=0.0, y=0.0)
pos2	Vector to bottom right end point of the rectangle (default: x=1.0, y=1.0)
relative	If this is set to true (default) the vector data are relative [0.0, 1.0]; else absolut [px]

◆ setInputRect() [5/5]

Blit& Procedural::Blit::setInputRect	(	size_t	x1,
		size_t	y1,
		size_t	x2,
		size_t	y2
	)

Set the full rectangle coordinates of the input buffer to copy.

Parameters

x1	New absolute x position of rectangle start (default 0)
y1	New absolute y position of rectangle start (default 0)
x2	New absolute x position of rectangle end (default: image width)
y2	New absolute y position of rectangle end (default: image height)

◆ setLog()

void Procedural::TextureProcessing::setLog ( bool enable = true )

inherited

Enable/Disable logging.

Parameters

enable true enables logging of filter actions