CascadeBitmap.h

Go to the documentation of this file.

//
// CascadeBitmap.h - header file for class CascadeBitmap
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADEBITMAP_H
#define _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADEBITMAP_H

#include <cascade/CascadeObject.h>
#include <cascade/util/CascadeString.h>
#include <cascade/util/CascadeFile.h>
#include <cascade/graphics/CascadeDims.h>
#include <cascade/graphics/CascadePoint.h>
#include <cascade/graphics/CascadeRect.h>
#include <cascade/graphics/CascadeColor.h>
#include <cascade/graphics/CascadeFont.h>
#include <cascade/interprocess/CascadeSharedMemZone.h>

// class CascadeBitmap #defines
#define TEXTOUT_TOP      (0)
#define TEXTOUT_BOTTOM   (1 << 0)
#define TEXTOUT_BASELINE (1 << 1)




#define TEXT_CENTER_VERTICALLY      (1 << 0)
#define TEXT_CENTER_HORIZONTALLY    (1 << 1)
#define TEXT_JUSTIFY_LEFT           (1 << 2)
#define TEXT_JUSTIFY_TOP            (1 << 3)
#define TEXT_JUSTIFY_BOTTOM         (1 << 4)
#define TEXT_JUSTIFY_RIGHT          (1 << 5)
#define TEXT_WORD_WRAP              (1 << 6)
#define TEXT_CLIP                   (1 << 7)
#define TEXT_CLIP_WITH_DOTDOTDOT    (1 << 8)
#define TEXT_MEASURE_ONLY           (1 << 9)
#define TEXT_CLIP_LEFT              (1 << 10)
#define TEXT_CLIP_CENTER            (1 << 11)
#define TEXT_DONT_WRAP_ON_SPACE     (1 << 12)














class CascadeBitmap : public CascadeObject
{

public:
        CascadeBitmap();
    virtual ~CascadeBitmap();

public:
    enum RamType {
        kVRAMOnly = 0,      
        kMainRAMOnly = 1,   
        kEither = 2         
    };
    
public:
    virtual bool Create(const CascadeDims & dims, RamType ramType = kEither);

public:
    virtual bool CreateFromBitmapFile(CascadeFile & bitmapFile, RamType ramType = kEither);

public:
    virtual bool Destroy();
                
public:
    inline CascadeRect GetClipRect() const { return m_clipRect; }
        
    void SetClipRect(const CascadeRect & rect);
    
public:
    virtual void FrameRect(const CascadeRect & rect, const CascadeColor & color );

    virtual void FillRect(const CascadeRect & rect, const CascadeColor & color);
        
    virtual void DrawLine(const CascadePoint & start, const CascadePoint & end, const CascadeColor & color);
        
    virtual void TextOut(const CascadePoint & point, const CascadeString & string, const CascadeFont & font, const CascadeColor & color, u32 nFlags = TEXTOUT_TOP);

        virtual bool DrawText(CascadeFont & font, const CascadeRect & rect, const CascadeString & string, const CascadeColor & color, u32 nFlags);

    virtual void Blit(const CascadePoint & point, const CascadeBitmap & source, const CascadeRect & sourceRect);
    virtual void Blit(const CascadePoint & point, CascadeSharedMemZone & sourceZone, u32 nZoneOffset, u32 nPixelWidth, u32 nPixelHeight, u32 nBitDepth, const CascadeRect & sourceRect);
    virtual bool GrabBits(const CascadeRect & sourceRect, CascadeSharedMemZone & destZone, u32 nZoneOffset);
    virtual void GetPixel(const CascadePoint & point, CascadeColor & colorToSet) const;
        
    virtual void SetPixel(const CascadePoint & point, const CascadeColor & color);

    virtual CascadeDims GetDims() const;

    inline CascadeRect GetRect() const { CascadeDims dims(GetDims()); return CascadeRect(0, 0, dims.w, dims.h); }

    virtual u8 GetColorDepth() const;

    virtual void * GetMemory();

    virtual void Flush();

private:

#ifndef DOXY_SKIP
    friend class CascadeScreen;
#endif

    virtual void * AcquireDriverObject() const; // not really const but I know what I'm doing
    virtual void   ReleaseDriverObject() const; // not really const but I know what I'm doing
    
private:
    void * m_pBitmapInternal;

protected:
    CascadeRect m_clipRect;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADEBITMAP_H

//  LOG
//  20-Jan-03   dwoodward       created
//  20-Jan-03   dwoodward       1.0 STATUS: 100% complete
//  21-Jan-03   dwoodward   added CreateFromBitmapFile
//  27-Jan-03   dwoodward   added AcquireDriverObject and ReleaseDriverObject
//  10-Feb-03   dwoodward   added GetClipRect and SetClipRect; made some functions const
//  12-Feb-03   dwoodward   added nFlags to TextOut
//  19-Feb-03   dwoodward   added RamType parameter to Create functions
//  06-Mar-03   dwoodward   added Destroy()
//  22-Apr-03   dwoodward   added overloaded version of Blit() that takes a CascadeSharedMemZone
//  05-May-03   dwoodward   doxygenated
//  05-Aug-03   dsletten    added DrawText()
//  19-Aug-03   mjkobb      Added TEXT_CLIP_LEFT and TEXT_CLIP_CENTER
//  21-Aug-03   dwoodward   removed GL stuff
//  03-Sep-04   dwoodward   added GrabBits()
//  21-Apr-05   dwoodward   added GetMemory()
//  22-Apr-05   dwoodward   added Flush()

---