iPlug2 - C++ Audio Plug-in Framework
Public Member Functions | List of all members
ILayer Class Reference

An abstraction that is used to store a temporary raster image/framebuffer. More...

#include <IGraphicsStructs.h>

Public Member Functions

 ILayer (APIBitmap *pBitmap, const IRECT &layerRect, IControl *pControl, const IRECT &controlRect)
 Create a layer/offscreen context (used internally) More...
 
 ILayer (const ILayer &)=delete
 
ILayer operator= (const ILayer &)=delete
 
void Invalidate ()
 Mark the layer as needing its contents redrawn.
 
const APIBitmapGetAPIBitmap () const
 
IBitmap GetBitmap () const
 
const IRECTBounds () const
 

Detailed Description

An abstraction that is used to store a temporary raster image/framebuffer.

The layer is drawn with a specific offset to the graphics context. ILayers take ownership of the underlying bitmaps In GPU-based backends (NanoVG), this is a texture.

Definition at line 2326 of file IGraphicsStructs.h.

Constructor & Destructor Documentation

ILayer::ILayer ( APIBitmap pBitmap,
const IRECT layerRect,
IControl pControl,
const IRECT controlRect 
)
inline

Create a layer/offscreen context (used internally)

Parameters
pBitmapThe APIBitmap to use for the layer
layerRectThe bounds of the layer withing the graphics context
pControlThe control that the layer belongs to
controlRectThe bounds of the control

Definition at line 2336 of file IGraphicsStructs.h.

Member Function Documentation

const IRECT& ILayer::Bounds ( ) const
inline
Returns
const IRECT& The bounds of the layer withing the graphics context

Definition at line 2357 of file IGraphicsStructs.h.

Referenced by IGraphics::PushLayer().

const APIBitmap* ILayer::GetAPIBitmap ( ) const
inline
Returns
const APIBitmap* The API bitmap for the layer

Definition at line 2351 of file IGraphicsStructs.h.

IBitmap ILayer::GetBitmap ( ) const
inline
Returns
IBitmap An IBitmap to use the layer directly

Definition at line 2354 of file IGraphicsStructs.h.


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