Bitmap layer using another bitmap as a mask. More...

#include <scene.h>

Inheritance diagram for Beatmup::Scene::MaskedBitmapLayer:

Public Member Functions
const AbstractBitmap *	getMask () const

void	setMask (AbstractBitmap *mask)

bool	testPoint (float x, float y) const
	Tests if a given point falls in the layer. More...

Public Member Functions inherited from Beatmup::Scene::CustomMaskedBitmapLayer
AffineMapping &	getMaskMapping ()

const AffineMapping &	getMaskMapping () const

void	setMaskMapping (const AffineMapping &mapping)

color4i	getBackgroundColor () const

void	setBackgroundColor (color4i color)

Public Member Functions inherited from Beatmup::Scene::BitmapLayer
const AbstractBitmap *	getBitmap () const

void	setBitmap (AbstractBitmap *bitmap)

AffineMapping &	getBitmapMapping ()

const AffineMapping &	getBitmapMapping () const

void	setBitmapMapping (const AffineMapping &mapping)

color4i	getModulationColor () const

void	setModulationColor (color4i color)

Public Member Functions inherited from Beatmup::Scene::Layer
Type	getType () const

const std::string &	getName () const

void	setName (const char *name)

AffineMapping &	getMapping ()

const AffineMapping &	getMapping () const

void	setMapping (const AffineMapping &mapping)

virtual Layer *	getChild (float x, float y, unsigned int recursionDepth=0) const
	Picks a child layer at given point, if any. More...

bool	isVisible () const
	Returns layer visibility flag. More...

bool	isPhantom () const
	Returns `true` if the layer is ignored when searching a layer by point. More...

void	setVisible (bool visible)
	Sets layer visibility. More...

void	setPhantom (bool phantom)
	Makes/unmakes the layer "phantom". More...

template<class LayerType >
LayerType &	castTo () const

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

Protected Member Functions
	MaskedBitmapLayer ()

void	render (RenderingContext &context)

Protected Member Functions inherited from Beatmup::Scene::CustomMaskedBitmapLayer
	CustomMaskedBitmapLayer (Type type)

void	configure (RenderingContext &context, GL::TextureHandler *content)

Protected Member Functions inherited from Beatmup::Scene::BitmapLayer
	BitmapLayer ()

	BitmapLayer (Type type)

GL::TextureHandler *	resolveContent (RenderingContext &context)

void	configure (RenderingContext &context, GL::TextureHandler *content)
	Configures current rendering program to render this layer. More...

Protected Member Functions inherited from Beatmup::Scene::Layer
	Layer (Type type)

Private Attributes
AbstractBitmap *	mask
	mask bitmap More...

Friends
class	Scene

class	SceneRenderer

Additional Inherited Members
Public Types inherited from Beatmup::Scene::Layer
enum class	Type { SceneLayer = 0 , BitmapLayer , MaskedBitmapLayer , ShapedBitmapLayer , ShadedBitmapLayer }

Protected Attributes inherited from Beatmup::Scene::CustomMaskedBitmapLayer
AffineMapping	maskMapping
	mask mapping w.r.t. the layer mapping More...

color4i	bgColor
	color to fill mask areas where the bitmap is not present More...

Protected Attributes inherited from Beatmup::Scene::BitmapLayer
float	invAr
	inverse aspect ratio of what is rendered (set by SceneRenderer) More...

AbstractBitmap *	bitmap
	content to display, used if the image source is set to BITMAP More...

AffineMapping	bitmapMapping
	bitmap mapping w.r.t. the layer mapping More...

color4i	modulation
	modulation color More...

Protected Attributes inherited from Beatmup::Scene::Layer
AffineMapping	mapping
	layer mapping More...

bool	visible
	layer visibility More...

bool	phantom
	if `true`, layer is ignored by selection by point More...

Detailed Description

Bitmap layer using another bitmap as a mask.

Definition at line 217 of file scene.h.

Constructor & Destructor Documentation

◆ MaskedBitmapLayer()

Scene::MaskedBitmapLayer::MaskedBitmapLayer ( )

protected

Definition at line 338 of file scene.cpp.

                                           :
     CustomMaskedBitmapLayer(Type::MaskedBitmapLayer), mask(NULL)
 {}

Member Function Documentation

◆ render()

void Scene::MaskedBitmapLayer::render ( RenderingContext & context )

protectedvirtual

Reimplemented from Beatmup::Scene::BitmapLayer.

Definition at line 343 of file scene.cpp.

                                                              {
     GL::TextureHandler* content = resolveContent(context);
     if (content && mask) {
         const bool mask8bit = mask->getPixelFormat() == PixelFormat::SingleByte;
  
         // program selection
         switch (content->getTextureFormat()) {
         case GL::TextureHandler::TextureFormat::OES_Ext:
             context.enableProgram(mask8bit ?
                 GL::RenderingPrograms::Operation::MASKED_8BIT_BLEND_EXT :
                 GL::RenderingPrograms::Operation::MASKED_BLEND_EXT
             );
             break;
         default:
             context.enableProgram(mask8bit ?
                 GL::RenderingPrograms::Operation::MASKED_8BIT_BLEND :
                 GL::RenderingPrograms::Operation::MASKED_BLEND);
             break;
         }
  
         context.lockBitmap(mask);
  
         CustomMaskedBitmapLayer::configure(context, content);
         context.bindMask(*mask);
         context.blend();
     }
 }

◆ getMask()

const AbstractBitmap* Beatmup::Scene::MaskedBitmapLayer::getMask ( ) const

inline

Definition at line 226 of file scene.h.

226 { return mask; }

◆ setMask()

void Beatmup::Scene::MaskedBitmapLayer::setMask ( AbstractBitmap * mask )

inline

Definition at line 227 of file scene.h.

227 { this->mask = mask; }

◆ testPoint()

bool Scene::MaskedBitmapLayer::testPoint	(	float	x,
		float	y
	)		const

virtual

Tests if a given point falls in the layer.

Reimplemented from Beatmup::Scene::BitmapLayer.

Definition at line 372 of file scene.cpp.

                                                              {
     // no bitmap - no deal (if the source is set to bitmap)
     if (!bitmap)
         return false;
     if (mask) {
         RuntimeError::check(mask->isUpToDate(ProcessingTarget::CPU), "Mask is out of date on CPU.");
         const Point p = (mapping * maskMapping).getInverse(x, y);
         int
             w = floorf_fast(mask->getWidth() * p.x),
             h = floorf_fast(mask->getHeight() * p.y);
         if (0 <= w && w < mask->getWidth() && 0 <= h && h < mask->getHeight()) {
             AbstractBitmap::ReadLock lock(*mask);
             bool result = mask->getPixelInt(w, h) > 0;
             return result;
         }
         return false;
     }
     return BitmapLayer::testPoint(x, y);
 }

Friends And Related Function Documentation

◆ Scene

friend class Scene

friend

Definition at line 218 of file scene.h.

◆ SceneRenderer

friend class SceneRenderer

friend

Definition at line 219 of file scene.h.

Member Data Documentation

◆ mask

AbstractBitmap* Beatmup::Scene::MaskedBitmapLayer::mask

private

mask bitmap

Definition at line 221 of file scene.h.

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

core/scene/scene.h
core/scene/scene.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members