Powered by NetworkEleven ImageMagick logo

NAME

pixel_wand - Pixel Wand

SYNOPSIS

void DestroyPixelWand( PixelWand *wand );

void DestroyPixelWands( PixelWand ** wand, const unsigned long number_wands );

PixelWand NewPixelWand( void );

double PixelGetAlpha( const PixelWand *wand );

Quantum PixelGetAlphaQuantum( const PixelWand *wand );

double PixelGetBlack( const PixelWand *wand );

Quantum PixelGetBlackQuantum( const PixelWand *wand );

double PixelGetBlue( const PixelWand *wand );

Quantum PixelGetBlueQuantum( const PixelWand *wand );

char * PixelGetColorAsString( PixelWand *wand );

unsigned long PixelGetColorCount( const PixelWand *wand );

double PixelGetCyan( const PixelWand *wand );

Quantum PixelGetCyanQuantum( const PixelWand *wand );

char * PixelGetException( const PixelWand *wand, ExceptionType *severity );

double PixelGetGreen( const PixelWand *wand );

Quantum PixelGetGreenQuantum( const PixelWand *wand );

IndexPacket PixelGetIndex( const PixelWand *wand );

double PixelGetMagenta( const PixelWand *wand );

Quantum PixelGetMagentaQuantum( const PixelWand *wand );

double PixelGetOpacity( const PixelWand *wand );

Quantum PixelGetOpacityQuantum( const PixelWand *wand );

double PixelGetRed( const PixelWand *wand );

Quantum PixelGetRedQuantum( const PixelWand *wand );

double PixelGetYellow( const PixelWand *wand );

Quantum PixelGetYellowQuantum( const PixelWand *wand );

void PixelSetAlpha( PixelWand *wand, const double opacity );

void PixelSetAlphaQuantum( PixelWand *wand, const Quantum opacity );

void PixelSetBlack( PixelWand *wand, const double black );

void PixelSetBlackQuantum( PixelWand *wand, const Quantum black );

void PixelSetBlue( PixelWand *wand, const double blue );

void PixelSetBlueQuantum( PixelWand *wand, const Quantum blue );

MagickBooleanType PixelSetColor( PixelWand *wand, const char *color );

void PixelSetColorCount( PixelWand *wand, const unsigned long count );

void PixelSetCyan( PixelWand *wand, const double cyan );

void PixelSetCyanQuantum( PixelWand *wand, const Quantum cyan );

void PixelSetGreen( PixelWand *wand, const double green );

void PixelSetGreenQuantum( PixelWand *wand, const Quantum green );

void PixelSetIndex( PixelWand *wand, const IndexPacket index );

void PixelSetMagenta( PixelWand *wand, const double magenta );

void PixelSetMagentaQuantum( PixelWand *wand, const Quantum magenta );

void PixelSetOpacity( PixelWand *wand, const double opacity );

void PixelSetOpacityQuantum( PixelWand *wand, const Quantum opacity );

PixelSetQuantumColor( PixelWand *wand, const PixelPacket *color );

void PixelSetRed( PixelWand *wand, const double red );

void PixelSetRedQuantum( PixelWand *wand, const Quantum red );

void PixelSetYellow( PixelWand *wand, const double yellow );

void PixelSetYellowQuantum( PixelWand *wand, const Quantum yellow );

FUNCTION DESCRIPTIONS

DestroyPixelWand

DestroyPixelWand() deallocates resources associated with a PixelWand.

The format of the DestroyPixelWand method is:

void DestroyPixelWand ( PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

DestroyPixelWands

DestroyPixelWands() deallocates resources associated with an array of pixel wands.

The format of the DestroyPixelWands method is:

void DestroyPixelWands ( PixelWand **wand, const unsigned long number_wands );

A description of each parameter follows:

wand:
The pixel wand.

number_wands:
The number of wands.

NewPixelWand

NewPixelWand() returns a new pixel wand.

The format of the NewPixelWand method is:

PixelWand NewPixelWand ( void );

NewPixelWands

NewPixelWands() returns an array of pixel wands.

The format of the NewPixelWand method is:

    PixelWand NewPixelWand(const unsigned long number_wands)

A description of each parameter follows:

number_wands:
The number of wands.

PixelGetException

PixelGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

The format of the PixelGetException method is:

char *PixelGetException ( const PixelWand *wand, ExceptionType *severity );

A description of each parameter follows:

wand:
The pixel wand.

severity:
The severity of the error is returned here.

PixelGetAlpha

PixelGetAlpha() returns the normalized alpha color of the pixel wand.

The format of the PixelGetAlpha method is:

double PixelGetAlpha ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetAlphaQuantum

PixelGetAlphaQuantum() returns the alpha color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetAlphaQuantum method is:

Quantum PixelGetAlphaQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetBlack

PixelGetBlack() returns the normalized black color of the pixel wand.

The format of the PixelGetBlack method is:

double PixelGetBlack ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetBlackQuantum

PixelGetBlackQuantum() returns the black color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetBlackQuantum method is:

Quantum PixelGetBlackQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetBlue

PixelGetBlue() returns the normalized blue color of the pixel wand.

The format of the PixelGetBlue method is:

double PixelGetBlue ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetBlueQuantum

PixelGetBlueQuantum() returns the blue color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetBlueQuantum method is:

Quantum PixelGetBlueQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetColorAsString

PixelGetColorAsString() gets the color of the pixel wand.

The format of the PixelGetColorAsString method is:

char *PixelGetColorAsString ( PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetColorCount

PixelGetColorCount() returns the color count associated with this color.

The format of the PixelGetColorCount method is:

unsigned long PixelGetColorCount ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetCyan

PixelGetCyan() returns the normalized cyan color of the pixel wand.

The format of the PixelGetCyan method is:

double PixelGetCyan ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetCyanQuantum

PixelGetCyanQuantum() returns the cyan color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetCyanQuantum method is:

Quantum PixelGetCyanQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetGreen

PixelGetGreen() returns the normalized green color of the pixel wand.

The format of the PixelGetGreen method is:

double PixelGetGreen ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetGreenQuantum

PixelGetGreenQuantum() returns the green color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetGreenQuantum method is:

Quantum PixelGetGreenQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetIndex

PixelGetIndex() returns the colormap index from the pixel wand.

The format of the PixelGetIndex method is:

IndexPacket PixelGetIndex ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetMagenta

PixelGetMagenta() returns the normalized magenta color of the pixel wand.

The format of the PixelGetMagenta method is:

double PixelGetMagenta ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetMagentaQuantum

PixelGetMagentaQuantum() returns the magenta color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetMagentaQuantum method is:

Quantum PixelGetMagentaQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetOpacity

PixelGetOpacity() returns the normalized opacity color of the pixel wand.

The format of the PixelGetOpacity method is:

double PixelGetOpacity ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetOpacityQuantum

PixelGetOpacityQuantum() returns the opacity color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetOpacityQuantum method is:

Quantum PixelGetOpacityQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetRed

PixelGetRed() returns the normalized red color of the pixel wand.

The format of the PixelGetRed method is:

double PixelGetRed ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetRedQuantum

PixelGetRedQuantum() returns the red color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetRedQuantum method is:

Quantum PixelGetRedQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetYellow

PixelGetYellow() returns the normalized yellow color of the pixel wand.

The format of the PixelGetYellow method is:

double PixelGetYellow ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelGetYellowQuantum

PixelGetYellowQuantum() returns the yellow color of the pixel wand. The color is in the range of [0..MaxRGB]

The format of the PixelGetYellowQuantum method is:

Quantum PixelGetYellowQuantum ( const PixelWand *wand );

A description of each parameter follows:

wand:
The pixel wand.

PixelSetAlpha

PixelSetAlpha() sets the normalized alpha color of the pixel wand.

The format of the PixelSetAlpha method is:

void PixelSetAlpha ( PixelWand *wand, const double opacity );

A description of each parameter follows:

wand:
The pixel wand.

opacity:
The opacity color.

PixelSetAlphaQuantum

PixelSetAlphaQuantum() sets the alpha color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetAlphaQuantum method is:

void PixelSetAlphaQuantum ( PixelWand *wand, const Quantum opacity );

A description of each parameter follows:

wand:
The pixel wand.

opacity:
The opacity color.

PixelSetBlack

PixelSetBlack() sets the normalized black color of the pixel wand.

The format of the PixelSetBlack method is:

void PixelSetBlack ( PixelWand *wand, const double black );

A description of each parameter follows:

wand:
The pixel wand.

black:
The black color.

PixelSetBlackQuantum

PixelSetBlackQuantum() sets the black color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetBlackQuantum method is:

void PixelSetBlackQuantum ( PixelWand *wand, const Quantum black );

A description of each parameter follows:

wand:
The pixel wand.

black:
The black color.

PixelSetBlue

PixelSetBlue() sets the normalized blue color of the pixel wand.

The format of the PixelSetBlue method is:

void PixelSetBlue ( PixelWand *wand, const double blue );

A description of each parameter follows:

wand:
The pixel wand.

blue:
The blue color.

PixelSetBlueQuantum

PixelSetBlueQuantum() sets the blue color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetBlueQuantum method is:

void PixelSetBlueQuantum ( PixelWand *wand, const Quantum blue );

A description of each parameter follows:

wand:
The pixel wand.

blue:
The blue color.

PixelSetColor

PixelSetColor() sets the color of the pixel wand with a string ( e.g. "blue", "#0000ff", "rgb ( 0, 0, 255 ) ", "cmyk ( 100, 100, 100, 10 ) ", etc. ) .

The format of the PixelSetColor method is:

MagickBooleanType PixelSetColor ( PixelWand *wand, const char *color );

A description of each parameter follows:

wand:
The pixel wand.

color:
The pixel wand color.

PixelSetColorCount

PixelSetColorCount() sets the color count of the pixel wand.

The format of the PixelSetColorCount method is:

void PixelSetColorCount ( PixelWand *wand, const unsigned long count );

A description of each parameter follows:

wand:
The pixel wand.

count:
The number of this particular color.

PixelSetCyan

PixelSetCyan() sets the normalized cyan color of the pixel wand.

The format of the PixelSetCyan method is:

void PixelSetCyan ( PixelWand *wand, const double cyan );

A description of each parameter follows:

wand:
The pixel wand.

cyan:
The cyan color.

PixelSetCyanQuantum

PixelSetCyanQuantum() sets the cyan color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetCyanQuantum method is:

void PixelSetCyanQuantum ( PixelWand *wand, const Quantum cyan );

A description of each parameter follows:

wand:
The pixel wand.

cyan:
The cyan color.

PixelSetGreen

PixelSetGreen() sets the normalized green color of the pixel wand.

The format of the PixelSetGreen method is:

void PixelSetGreen ( PixelWand *wand, const double green );

A description of each parameter follows:

wand:
The pixel wand.

green:
The green color.

PixelSetGreenQuantum

PixelSetGreenQuantum() sets the green color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetGreenQuantum method is:

void PixelSetGreenQuantum ( PixelWand *wand, const Quantum green );

A description of each parameter follows:

wand:
The pixel wand.

green:
The green color.

PixelSetIndex

PixelSetIndex() sets the colormap index of the pixel wand.

The format of the PixelSetIndex method is:

void PixelSetIndex ( PixelWand *wand, const IndexPacket index );

A description of each parameter follows:

wand:
The pixel wand.

index:
The colormap index.

PixelSetMagenta

PixelSetMagenta() sets the normalized magenta color of the pixel wand.

The format of the PixelSetMagenta method is:

void PixelSetMagenta ( PixelWand *wand, const double magenta );

A description of each parameter follows:

wand:
The pixel wand.

magenta:
The magenta color.

PixelSetMagentaQuantum

PixelSetMagentaQuantum() sets the magenta color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetMagentaQuantum method is:

void PixelSetMagentaQuantum ( PixelWand *wand, const Quantum magenta );

A description of each parameter follows:

wand:
The pixel wand.

magenta:
The green magenta.

PixelSetOpacity

PixelSetOpacity() sets the normalized opacity color of the pixel wand.

The format of the PixelSetOpacity method is:

void PixelSetOpacity ( PixelWand *wand, const double opacity );

A description of each parameter follows:

wand:
The pixel wand.

opacity:
The opacity color.

PixelSetOpacityQuantum

PixelSetOpacityQuantum() sets the opacity color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetOpacityQuantum method is:

void PixelSetOpacityQuantum ( PixelWand *wand, const Quantum opacity );

A description of each parameter follows:

wand:
The pixel wand.

opacity:
The opacity color.

PixelSetQuantumColor

PixelSetQuantumColor() sets the color of the pixel wand.

The format of the PixelSetQuantumColor method is:

PixelSetQuantumColor ( PixelWand *wand, const PixelPacket *color );

A description of each parameter follows:

wand:
The pixel wand.

color:
Return the pixel wand color here.

PixelSetRed

PixelSetRed() sets the normalized red color of the pixel wand.

The format of the PixelSetRed method is:

void PixelSetRed ( PixelWand *wand, const double red );

A description of each parameter follows:

wand:
The pixel wand.

red:
The red color.

PixelSetRedQuantum

PixelSetRedQuantum() sets the red color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetRedQuantum method is:

void PixelSetRedQuantum ( PixelWand *wand, const Quantum red );

A description of each parameter follows:

wand:
The pixel wand.

red:
The red color.

PixelSetYellow

PixelSetYellow() sets the normalized yellow color of the pixel wand.

The format of the PixelSetYellow method is:

void PixelSetYellow ( PixelWand *wand, const double yellow );

A description of each parameter follows:

wand:
The pixel wand.

yellow:
The yellow color.

PixelSetYellowQuantum

PixelSetYellowQuantum() sets the yellow color of the pixel wand. The color must be in the range of [0..MaxRGB]

The format of the PixelSetYellowQuantum method is:

void PixelSetYellowQuantum ( PixelWand *wand, const Quantum yellow );

A description of each parameter follows:

wand:
The pixel wand.

yellow:
The yellow color.
Top of page
"Image manipulation software that works like magick"