iPlug 2: IBitmap Class Reference

User-facing bitmap abstraction that you use to manage bitmap data, independant of draw class/platform. More...

#include <IGraphicsStructs.h>

Public Member Functions

 IBitmap (APIBitmap *pAPIBitmap, int n, bool framesAreHorizontal, const char *name="")
 IBitmap Constructor. More...
 
int W () const
 
int H () const
 
int FW () const
 
int FH () const
 
int N () const
 
float GetScale () const
 
float GetDrawScale () const
 
APIBitmapGetAPIBitmap () const
 
bool GetFramesAreHorizontal () const
 
const WDL_String & GetResourceName () const
 
bool IsValid () const
 

User-facing bitmap abstraction that you use to manage bitmap data, independant of draw class/platform.

IBitmap doesn't actually own the image data

See also
APIBitmap An IBitmap's width and height are always in relation to a 1:1 (low dpi) screen. Any scaling happens at the drawing stage.

Definition at line 87 of file IGraphicsStructs.h.

IBitmap::IBitmap ( APIBitmap pAPIBitmap,
int  n,
bool  framesAreHorizontal,
const char *  name = "" 
)
inline

IBitmap Constructor.

Parameters
pAPIBitmapPointer to a drawing API bitmap
nNumber of frames (for multi frame film-strip bitmaps)
framesAreHorizontalframesAreHorizontal true if the frames are positioned horizontally
nameResource name for the bitmap

Definition at line 95 of file IGraphicsStructs.h.

◆ IBitmap() [2/2]

IBitmap::IBitmap ( )
inline

◆ FH()

int IBitmap::FH ( ) const
inline

◆ FW()

int IBitmap::FW ( ) const
inline

◆ GetAPIBitmap()

APIBitmap * IBitmap::GetAPIBitmap ( ) const
inline

◆ GetDrawScale()

float IBitmap::GetDrawScale ( ) const
inline

◆ GetFramesAreHorizontal()

bool IBitmap::GetFramesAreHorizontal ( ) const
inline

◆ GetResourceName()

const WDL_String & IBitmap::GetResourceName ( ) const
inline

◆ GetScale()

float IBitmap::GetScale ( ) const
inline

◆ H()

int IBitmap::H ( ) const
inline

◆ IsValid()

bool IBitmap::IsValid ( ) const
inline

◆ N()

int IBitmap::N ( ) const
inline

◆ W()

int IBitmap::W ( ) const
inline

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