PCX

Implements ZSoft PCX file handling. Dummied out due to complexity.

Constructors

this
this()

Blank constructor for files

this
this(Header header, ubyte[] imageData, ubyte[] paletteData)

Basic constructor to create pcx objects

Members

Enums

Version
enum Version

Version information

Functions

getBitdepth
ubyte getBitdepth()
Undocumented in source. Be warned that the author may not have intended to support it.
getBitplanes
ubyte getBitplanes()

Returns the number of planes the image have. If bitdepth is 1, then the image is a planar indexed image.

getPaletteBitdepth
ubyte getPaletteBitdepth()
Undocumented in source. Be warned that the author may not have intended to support it.
getPalettePixelFormat
uint getPalettePixelFormat()
Undocumented in source. Be warned that the author may not have intended to support it.
getPixelFormat
uint getPixelFormat()
Undocumented in source. Be warned that the author may not have intended to support it.
height
uint height()
Undocumented in source. Be warned that the author may not have intended to support it.
isIndexed
bool isIndexed()
Undocumented in source. Be warned that the author may not have intended to support it.
setupDelegates
void setupDelegates()
Undocumented in source. Be warned that the author may not have intended to support it.
width
uint width()
Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous
mixin PlanarAccess3Bit
Undocumented in source.
__anonymous
mixin PlanarAccess4Bit
Undocumented in source.
__anonymous
mixin ChunkyAccess2Bit
Undocumented in source.
__anonymous
mixin MonochromeAccess
Undocumented in source.

Static functions

load
load(F file)

Loads a *.PCX file.

Structs

Header
struct Header

Implementation of the PCX header

Variables

header
Header header;

Contains common information about the image

pitch
uint pitch;
Undocumented in source.

Inherited Members

From Image

_palette
IPalette _palette;

Contains palette data and information

_imageData
IImageData _imageData;

Contains image data and information.

mod
ubyte mod;

used for fast access of indexes DEPRECATED!

shift
ubyte shift;

used for fast access of indexes DEPRECATED!

width
uint width [@property getter]

Returns the width of the image in pixels.

height
uint height [@property getter]

Returns the height of the image in pixels.

isIndexed
bool isIndexed [@property getter]

Returns true if the image is indexed.

getBitdepth
ubyte getBitdepth [@property getter]

Returns the number of bits used per sample.

getPaletteBitdepth
ubyte getPaletteBitdepth [@property getter]

Returns the number of bits used per colormap entry.

getPixelFormat
uint getPixelFormat [@property getter]

Returns the pixelformat of the image. See enumerator PixelFormat for more info.

getPalettePixelFormat
uint getPalettePixelFormat [@property getter]

Returns the pixelformat of the palette. See enumerator PixelFormat for more info.

backgroundColorIndex
int backgroundColorIndex [@property getter]

Returns the background color index if there's any. Returns -1 if there's no background color, -2 if background color is not indexed.

backgroundColor
ARGB8888 backgroundColor [@property getter]

Returns the background color if there's any, or a default value otherwise.

getBitplanes
ubyte getBitplanes()

Returns the number of planes the image have. Default is one.

palette
IPalette palette()

Returns a palette range, which can be used to read the palette.

imageData
IImageData imageData()

Returns the image data.

readPixel
ARGB8888 readPixel(uint x, uint y)

Reads a single 32bit pixel. If the image is indexed, a color lookup will be done.

readPalette
ARGB8888 readPalette(size_t index)

Looks up the index on the palette, then returns the color value as a 32 bit value.

flipVertical
void flipVertical()

Flips the image on the vertical axis. Useful to set images to the correct top-left screen origin point.

flipHorizontal
void flipHorizontal()

Flips the image on the vertical axis. Useful to set images to the correct top-left screen origin point.

topOrigin
bool topOrigin()

Returns true if the image originates from the top

rightSideOrigin
bool rightSideOrigin()

Returns true if the image originates from the right

Meta