Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIDrawingSurface Class Reference

#include <nsIDrawingSurface.h>

Inheritance diagram for nsIDrawingSurface:
Inheritance graph
[legend]
Collaboration diagram for nsIDrawingSurface:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD Lock (PRInt32 aX, PRInt32 aY, PRUint32 aWidth, PRUint32 aHeight, void **aBits, PRInt32 *aStride, PRInt32 *aWidthBytes, PRUint32 aFlags)=0
 Lock a rect of a drawing surface and return a pointer to the upper left hand corner of the bitmap.
NS_IMETHOD Unlock (void)=0
 Unlock a rect of a drawing surface.
NS_IMETHOD GetDimensions (PRUint32 *aWidth, PRUint32 *aHeight)=0
 Get the dimensions of a drawing surface.
NS_IMETHOD IsOffscreen (PRBool *aOffScreen)=0
 Get the offscreen status of the drawing surface.
NS_IMETHOD IsPixelAddressable (PRBool *aAddressable)=0
 Get the pixel addressability status of the drawing surface.
NS_IMETHOD GetPixelFormat (nsPixelFormat *aFormat)=0
 Get the pixel format of a drawing surface.

Detailed Description

Definition at line 72 of file nsIDrawingSurface.h.


Member Function Documentation

NS_IMETHOD nsIDrawingSurface::GetDimensions ( PRUint32 aWidth,
PRUint32 aHeight 
) [pure virtual]

Get the dimensions of a drawing surface.

Parameters:
aWidthout parameter for width of drawing surface
aHeightout parameter for height of drawing surface
Returns:
error status

Implemented in nsWindowSurface, nsDrawingSurfaceGTK, nsDrawingSurfaceOS2, nsCairoDrawingSurface, nsDrawingSurfaceXlibImpl, nsXPrintContext, nsDrawingSurfaceQt, nsDrawingSurfaceMac, nsDrawingSurfacePh, nsDrawingSurfaceBeOS, nsDrawingSurfaceWin, and nsIDrawingSurfaceXlib.

Here is the caller graph for this function:

Get the pixel format of a drawing surface.

Parameters:
aOffscreenout parameter filled in with pixel format information.
Returns:
error status

Implemented in nsOnscreenSurface, nsOffscreenSurface, nsDrawingSurfaceGTK, nsCairoDrawingSurface, nsDrawingSurfaceXlibImpl, nsDrawingSurfacePh, nsXPrintContext, nsDrawingSurfaceQt, nsDrawingSurfaceMac, nsDrawingSurfaceBeOS, nsDrawingSurfaceWin, and nsIDrawingSurfaceXlib.

Here is the caller graph for this function:

NS_IMETHOD nsIDrawingSurface::IsOffscreen ( PRBool aOffScreen) [pure virtual]

Get the offscreen status of the drawing surface.

Parameters:
aOffscreenout parameter for offscreen status of drawing surface. if PR_TRUE, then modifying the drawing surface does not immediately reflect the changes on the output device
Returns:
error status

Implemented in nsOnscreenSurface, nsOffscreenSurface, nsDrawingSurfaceGTK, nsCairoDrawingSurface, nsDrawingSurfaceXlibImpl, nsXPrintContext, nsDrawingSurfacePh, nsDrawingSurfaceQt, nsDrawingSurfaceMac, nsDrawingSurfaceBeOS, nsDrawingSurfaceWin, and nsIDrawingSurfaceXlib.

NS_IMETHOD nsIDrawingSurface::IsPixelAddressable ( PRBool aAddressable) [pure virtual]

Get the pixel addressability status of the drawing surface.

Parameters:
aAddressableout parameter for pixel addressability status of drawing surface. if PR_TRUE, then the drawing surface is optimized for pixel addressability (i.e. the Lock() method has very low overhead). All drawing surfaces support Lock()ing, but doing so on drawing surfaces that do not return PR_TRUE here may impose significant overhead.
Returns:
error status

Implemented in nsOnscreenSurface, nsOffscreenSurface, nsDrawingSurfaceGTK, nsCairoDrawingSurface, nsDrawingSurfaceXlibImpl, nsXPrintContext, nsDrawingSurfacePh, nsDrawingSurfaceQt, nsDrawingSurfaceMac, nsDrawingSurfaceBeOS, nsDrawingSurfaceWin, and nsIDrawingSurfaceXlib.

NS_IMETHOD nsIDrawingSurface::Lock ( PRInt32  aX,
PRInt32  aY,
PRUint32  aWidth,
PRUint32  aHeight,
void **  aBits,
PRInt32 aStride,
PRInt32 aWidthBytes,
PRUint32  aFlags 
) [pure virtual]

Lock a rect of a drawing surface and return a pointer to the upper left hand corner of the bitmap.

Parameters:
aXx position of subrect of bitmap
aYy position of subrect of bitmap
aWidthwidth of subrect of bitmap
aHeightheight of subrect of bitmap
aBitsout parameter for upper left hand corner of bitmap
aStrideout parameter for number of bytes to add to aBits to go from scanline to scanline
aWidthBytesout parameter for number of bytes per line in aBits to process aWidth pixels
Returns:
error status

Implemented in nsOnscreenSurface, nsOffscreenSurface, nsDrawingSurfaceGTK, nsCairoDrawingSurface, nsDrawingSurfaceXlibImpl, nsXPrintContext, nsDrawingSurfaceQt, nsDrawingSurfaceMac, nsDrawingSurfaceBeOS, nsDrawingSurfaceWin, nsDrawingSurfacePh, and nsIDrawingSurfaceXlib.

Here is the caller graph for this function:

Unlock a rect of a drawing surface.

must be preceded by a call to Lock(). Lock()/Unlock() pairs do not nest.

Returns:
error status

Implemented in nsOnscreenSurface, nsOffscreenSurface, nsDrawingSurfaceGTK, nsCairoDrawingSurface, nsDrawingSurfaceXlibImpl, nsXPrintContext, nsDrawingSurfaceQt, nsDrawingSurfaceMac, nsDrawingSurfaceBeOS, nsDrawingSurfaceWin, nsDrawingSurfacePh, and nsIDrawingSurfaceXlib.

Here is the caller graph for this function:


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