Class diagram for ptc::Surface:
The surface class represents a linear array of pixels in system memory.
The surface class manages information about the array of pixels, such as its width, height, pitch, pixel format and palette.
It provides routines for loading pixels to the surface, saving surface pixels to another buffer, copying surface pixels to other surfaces and clearing surface pixels to a specified color.
The surface class also manages a clipping rectangle through which all area parameters are first passed to ensure that no load, save, copy or clear operation can write outside of surface memory.
Surface pitch is always equal to width * format.bytes().
This means that surface memory is always linear - the first pixel of line y+1 is immediately after the last pixel of line y in memory for all lines y in the surface.
Be warned, although ptc::Surface guarantees linear memory - ptc::BaseSurface does not!
The documentation of this class only provides an overview for most members, for details see ptc::BaseSurface.
Creates a surface with dimensions of width by height pixels and a pixel format of format.
Frees all pixel memory and checks if the surface is still locked.
[virtual]
Copies the entire contents of this surface to the other surface specified in the surface parameter.
Reimplemented from ptc::BaseSurface.
[virtual]
Copies an area of this surface to an area of the other surface specified in the surface parameter.
Reimplemented from ptc::BaseSurface.
[virtual]
Locks the surface and returns a pointer to the locked surface pixel memory.
Reimplemented from ptc::BaseSurface.
[virtual]
Unlocks the surface pixel memory.
Reimplemented from ptc::BaseSurface.
[virtual]
Loads pixels from the pixel array pixels to the surface.
Reimplemented from ptc::BaseSurface.
[virtual]
Loads an area of pixels from the pixel array pixels to an area of the surface.
Reimplemented from ptc::BaseSurface.
[virtual]
Saves the surface pixels to the pixel array pixels.
Reimplemented from ptc::BaseSurface.
[virtual]
Saves an area of the surface pixels to an area of the pixel data array pixels.
Reimplemented from ptc::BaseSurface.
[virtual]
Clears the entire contents of the surface to black in direct color and index zero in indexed color.
Reimplemented from ptc::BaseSurface.
[virtual]
Clears the entire contents of the surface to the color specified in the color parameter.
Reimplemented from ptc::BaseSurface.
[virtual]
Clears the area of pixels of the surface specified by the area parameter to the color specified in the color parameter.
Reimplemented from ptc::BaseSurface.
[virtual]
Sets the surface palette to the palette specified in the palette parameter.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the surface palette object.
Reimplemented from ptc::BaseSurface.
[virtual]
Sets the surface clip area to the area specified by the area parameter.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the width of the surface in pixels.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the height of the surface in pixels.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the pitch of the surface in bytes.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the area of the surface.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the clip area of the surface.
Reimplemented from ptc::BaseSurface.
[virtual]
Gets the pixel format of the surface.
Reimplemented from ptc::BaseSurface.
[virtual]
Passes an implementation specific option string to the surface.
Reimplemented from ptc::BaseSurface.