CascadeScreen.h

Go to the documentation of this file.

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

#ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADESCREEN_H
#define _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADESCREEN_H

#include <cascade/graphics/CascadeBitmap.h>

// class CascadeScreen
/*
*/

class CascadeScreen : public CascadeBitmap
{
public:
        CascadeScreen();
    virtual ~CascadeScreen();
public:
    virtual void LockScreen();
    virtual void UnlockScreen();

public:
    enum VideoConnector {
        kVGA            = 0, 
        kComponent      = 1, 
        kSVideo         = 2, 
        kComposite      = 3,  
        kNumConnectors = kComposite + 1,
    };
    
    enum VideoMode {
        kNTSC           = 0, 
        kPAL        = 1, 
        kRGB        = 2, 
        kNumModes = kRGB + 1,
    };

public:
    virtual bool SetScreenResolution(u32 index);
    virtual void GetCurrentScreenResolution(u32 & index);
    virtual u32 GetNumScreenResolutionsSupported();
    virtual bool GetSupportedScreenResolutionAt(u32 nIndex, u32 & nWidthToSet, u32 & nHeightToSet, u8 & nBitDepthToSet, bool & bDoubleBufferedToSet);
    virtual void SwapBuffers(const CascadeRect & afterSwapCopyRect);
    virtual bool SetOutputResolution(u32 nIndex);
    virtual void GetCurrentOutputResolution(u32 & nIndexToSet);
    virtual u32 GetNumOutputResolutionsSupported();
    virtual bool GetSupportedOutputResolutionAt(u32 nIndex, u32 & nWidthToSet, u32 & nHeightToSet, bool & bProgressiveToSet, VideoConnector & connectorToSet, VideoMode & modeToSet, u32 & nRefreshRateToSet);
    virtual bool GetOutputResolutionScaleRect(u32 nIndex, CascadeRect & scaleRectToSet);
    virtual bool SetOutputResolutionScaleRect(u32 nIndex, const CascadeRect & scaleRect);
    virtual bool WaitForVBILineZero();
public:
    virtual bool SetBypassMode(bool bBypass);
    virtual bool GetBypassMode();
public: // virtual member functions from CascadeBitmap overridden and shanghai'd directly
    virtual bool Create(const CascadeDims & dims, CascadeBitmap::RamType = CascadeBitmap::kEither) { return false; }
    virtual bool CreateFromBitmapFile(CascadeFile & bitmapFile, CascadeBitmap::RamType = CascadeBitmap::kEither) { return false; }
    virtual bool Destroy() { return false; }
public: // drawing and info functions overridden from CascadeBitmap
    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);
        // This version of blit operates on a source bitmap that is contained in a CascadeSharedMemZone
        // and defined by the following parameters:
        // nZoneOffset - the byte offset from the start of the zone where the bitmap bits start
        // nPixelWidth - the width in pixels of the source bitmap
        // nPixelHeight - the height in pixels of the source bitmap
        // nBitDepth - the number of bits per pixel of the bits in the source bitmap
        // NOTE NOTE NOTE:  Currently the only pixel format supported
        //                  is 32bpp RGBA.
        // NOTE the CascadeSharedMemZone passed in as sourceZone must be an Open() zone, but not MapLocked().
    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;
    virtual u8 GetColorDepth() const;
    virtual void Flush();
        // These functions are overridden from base class versions in CascadeBitmap.
        // See CascadeBitmap for their descriptions.
    virtual void * GetMemory();
private:
    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_pScreenInternal;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADESCREEN_H

//  LOG
//  20-Jan-03   dwoodward       created
//  20-Jan-03   dwoodward       1.0 STATUS: 100% complete
//  27-Jan-03   dwoodward   added AcquireDriverObject and ReleaseDriverObject
//  12-Feb-03   dwoodward   added nFlags to TextOut
//  19-Feb-03   dwoodward   added screen resolution stuff and WaitForVBILineZero();
//                          added RamType parameter to Create functions
//  19-Feb-03   dwoodward   added output resolution stuff
//  06-Mar-03   dwoodward   added Destroy()
//  09-Apr-03   dwoodward   added bDoubleBuffered parameters
//  14-Apr-03   dwoodward   added SwapBuffers()
//  22-Apr-03   dwoodward   added overloaded version of Blit() that takes a CascadeSharedMemZone
//  05-May-03   dwoodward   doxygenated
//  27-May-03   dwoodward   got rid of IsScreenLocked()
//  16-Jun-03   dwoodward   added StartStreaming() and StopStreaming()
//  27-Jul-03   dwoodward   added SetBypassMode() and GetBypassMode()
//  28-Jul-03   dwoodward   added GetOutputResolutionScaleRect() and SetOutputResolutionScaleRect()
//  03-Sep-04   dwoodward   added GrabBits(); got rid of StartStreaming() and StopStreaming()
//  10-Nov-04   dwoodward   added DrawText()
//  21-Apr-05   dwoodward   added GetMemory()
//  22-Apr-05   dwoodward   added Flush()
//  15-Jun-05   dwoodward   added VideoMode and refresh rate parms to GetSupportedOutputResolutionAt()

---