Detailed Description

v2.00 (20 June 2023)
The GFX interface provides generic graphics methods.

Useful methods:

set and get individual pixels from an image or screen handle
horizontal line, vertical line and line primitives
draw an outlined and filled rectangle
draw an outlined and filled round rectangle
draw an outlined and filled circle
draw an outlined and filled ellipse
draw an outlined and filled polygon
color conversion (RGB<->HSV, RGB<->YUV, RGB<->CMYK and RGB<->YCC)

Drawing methods are fast enough for realtime effects when rendering to a screen.
However, when the target is an image, it is not so fast. This is not intended for realtime effects although some will not hurt, several of them will do.
Only a single instance of the GFX interface exists which is created once Main is instantiated.
You can get a reference to this interface using Main::IGFX() method.

Note: The GFX interface is automatically released when Main::Terminate() is called.
At this time, any resource still loaded, will be released avoding resource leaks.

Classes
class	CRM64Pro::GFX
	GFX class. More...

Functions
Sint32	CRM64Pro::GFX::info (Sint32 iMode=0)
	Request GFX Interface information.

Sint32	CRM64Pro::GFX::setSurfacePixel (Sint32 iX, Sint32 iY, Uint32 iColor, SDL_Surface *pSurf)
	Draw a pixel in a surface.

Uint32	CRM64Pro::GFX::getSurfacePixel (Sint32 iX, Sint32 iY, SDL_Surface *pSurf)
	Get a pixel color from a surface.

Sint32	CRM64Pro::GFX::setPixel (Sint32 iX, Sint32 iY, Uint32 iColor, Sint32 idRes=0)
	Draw a pixel.

Sint32	CRM64Pro::GFX::setPixel (Sint32 iX, Sint32 iY, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a pixel.

Uint32	CRM64Pro::GFX::getPixel (Sint32 iX, Sint32 iY, Sint32 idRes=0)
	Get a pixel color.

Sint32	CRM64Pro::GFX::lineH (Sint32 iX1, Sint32 iX2, Sint32 iY, Uint32 iColor, Sint32 idRes=0)
	Draw a horizontal line.

Sint32	CRM64Pro::GFX::lineH (Sint32 iX1, Sint32 iX2, Sint32 iY, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a horizontal line.

Sint32	CRM64Pro::GFX::lineV (Sint32 iX, Sint32 iY1, Sint32 iY2, Uint32 iColor, Sint32 idRes=0)
	Draw a vertical line.

Sint32	CRM64Pro::GFX::lineV (Sint32 iX, Sint32 iY1, Sint32 iY2, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a vertical line.

Sint32	CRM64Pro::GFX::line (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Uint32 iColor, Sint32 idRes=0)
	Draw a line.

Sint32	CRM64Pro::GFX::line (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a line.

Sint32	CRM64Pro::GFX::rect (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Uint32 iColor, Sint32 idRes=0)
	Draw an outlined rectangle.

Sint32	CRM64Pro::GFX::rect (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw an outlined rectangle.

Sint32	CRM64Pro::GFX::rectFilled (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Uint32 iColor, Sint32 idRes=0)
	Draw a filled rectangle.

Sint32	CRM64Pro::GFX::rectFilled (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a filled rectangle.

Sint32	CRM64Pro::GFX::rectRound (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Sint32 iRad, Uint32 iColor, Sint32 idRes=0)
	Draw a round outlined rectangle.

Sint32	CRM64Pro::GFX::rectRound (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Sint32 iRad, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a round outlined rectangle.

Sint32	CRM64Pro::GFX::rectFilledRound (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Sint32 iRad, Uint32 iColor, Sint32 idRes=0)
	Draw a round filled rectangle.

Sint32	CRM64Pro::GFX::rectFilledRound (Sint32 iX1, Sint32 iY1, Sint32 iX2, Sint32 iY2, Sint32 iRad, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a round filled rectangle.

Sint32	CRM64Pro::GFX::arc (Sint32 iX, Sint32 iY, Sint32 iRad, Sint32 iStart, Sint32 iEnd, Uint32 iColor, Sint32 idRes=0)
	Draw an arc.

Sint32	CRM64Pro::GFX::arc (Sint32 iX, Sint32 iY, Sint32 iRad, Sint32 iStart, Sint32 iEnd, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw an arc.

Sint32	CRM64Pro::GFX::circle (Sint32 iX, Sint32 iY, Sint32 iRad, Uint32 iColor, Sint32 idRes=0)
	Draw an outlined circle.

Sint32	CRM64Pro::GFX::circle (Sint32 iX, Sint32 iY, Sint32 iRad, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw an outlined circle.

Sint32	CRM64Pro::GFX::circleFilled (Sint32 iX, Sint32 iY, Sint32 iRad, Uint32 iColor, Sint32 idRes=0)
	Draw a filled circle.

Sint32	CRM64Pro::GFX::circleFilled (Sint32 iX, Sint32 iY, Sint32 iRad, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a filled circle.

Sint32	CRM64Pro::GFX::ellipse (Sint32 iX, Sint32 iY, Sint32 iRadX, Sint32 iRadY, Uint32 iColor, Sint32 idRes=0)
	Draw an outlined ellipse.

Sint32	CRM64Pro::GFX::ellipse (Sint32 iX, Sint32 iY, Sint32 iRadX, Sint32 iRadY, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw an outlined ellipse.

Sint32	CRM64Pro::GFX::ellipseFilled (Sint32 iX, Sint32 iY, Sint32 iRadX, Sint32 iRadY, Uint32 iColor, Sint32 idRes=0)
	Draw a filled ellipse.

Sint32	CRM64Pro::GFX::ellipseFilled (Sint32 iX, Sint32 iY, Sint32 iRadX, Sint32 iRadY, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a filled ellipse.

Sint32	CRM64Pro::GFX::polygon (Sint32 iVX, Sint32 iVY, Sint32 iNV, Uint32 iColor, Sint32 idRes=0)
	Draw an outlined polygon.

Sint32	CRM64Pro::GFX::polygon (Sint32 iVX, Sint32 iVY, Sint32 iNV, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw an outlined polygon.

Sint32	CRM64Pro::GFX::polygonFilled (Sint32 iVX, Sint32 iVY, Sint32 iNV, Uint32 iColor, Sint32 idRes=0)
	Draw a filled polygon.

Sint32	CRM64Pro::GFX::polygonFilled (Sint32 iVX, Sint32 iVY, Sint32 iNV, Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iA, Sint32 idRes=0)
	Draw a filled polygon.

Sint32	CRM64Pro::GFX::RGBtoHSV (Uint8 iR, Uint8 iG, Uint8 iB, float fH, float fS, float *fV)
	Color conversion from RGB to HSV.

Sint32	CRM64Pro::GFX::HSVtoRGB (float fH, float fS, float fV, Uint8 iR, Uint8 iG, Uint8 *iB)
	Color conversion from HSV to RGB.

Sint32	CRM64Pro::GFX::RGBtoYUV (Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iY, Uint8 iU, Uint8 *iV)
	Color conversion from RGB to YUV.

Sint32	CRM64Pro::GFX::YUVtoRGB (Uint8 iY, Uint8 iU, Uint8 iV, Uint8 iR, Uint8 iG, Uint8 *iB)
	Color conversion from YUV to RGB.

Sint32	CRM64Pro::GFX::RGBtoCMYK (Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iC, Uint8 iM, Uint8 iY, Uint8 iK)
	Color conversion from RGB to CMYK.

Sint32	CRM64Pro::GFX::CMYKtoRGB (Uint8 iC, Uint8 iM, Uint8 iY, Uint8 iK, Uint8 iR, Uint8 iG, Uint8 *iB)
	Color conversion from CMYK to RGB.

Sint32	CRM64Pro::GFX::RGBtoYCC (Uint8 iR, Uint8 iG, Uint8 iB, Uint8 iY, Uint8 Cb, Uint8 *Cr)
	Color conversion from RGB to YCC.

Sint32	CRM64Pro::GFX::YCCtoRGB (Uint8 iY, Uint8 Cb, Uint8 Cr, Uint8 iR, Uint8 iG, Uint8 *iB)
	Color conversion from YCC to RGB.

Function Documentation

◆ info()

Sint32 CRM64Pro::GFX::info ( Sint32 iMode = 0 )

Request GFX Interface information.

For displaying the information, it uses the default log.

Parameters

iMode unused for the time being.

Returns: 0 on success or a negative error code on failure.

◆ setSurfacePixel()

Sint32 CRM64Pro::GFX::setSurfacePixel	(	Sint32	iX,
		Sint32	iY,
		Uint32	iColor,
		SDL_Surface *	pSurf
	)

Draw a pixel in a surface.

Parameters

iX	X (horizontal) coordinate of the pixel.
iY	Y (vertical) coordinate of the pixel.
iColor	The color value of the pixel to draw (0xAARRGGBB).
pSurf	SDL_Surface pointer.

Returns: 0 on success or a negative error code on failure.

Note: For getting maximum performance, there is not any error checking.

◆ getSurfacePixel()

Uint32 CRM64Pro::GFX::getSurfacePixel	(	Sint32	iX,
		Sint32	iY,
		SDL_Surface *	pSurf
	)

Get a pixel color from a surface.

Parameters

iX	X (horizontal) coordinate of the pixel.
iY	Y (vertical) coordinate of the pixel.
pSurf	SDL_Surface pointer.

Returns: a 32bits unsigned integer with the value of the pixel value in the surface format.

Note: For getting maximum performance, there is not any error checking.

◆ setPixel() [1/2]

Sint32 CRM64Pro::GFX::setPixel	(	Sint32	iX,
		Sint32	iY,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a pixel.

Parameters

iX	X (horizontal) coordinate of the pixel.
iY	Y (vertical) coordinate of the pixel.
iColor	The color value of the pixel to draw (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ setPixel() [2/2]

Sint32 CRM64Pro::GFX::setPixel	(	Sint32	iX,
		Sint32	iY,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a pixel.

Parameters

iX	X (horizontal) coordinate of the pixel.
iY	Y (vertical) coordinate of the pixel.
iR	The red color value of the pixel to draw.
iG	The green color value of the pixel to draw.
iB	The blue color value of the pixel to draw.
iA	The alpha value of the pixel to draw.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ getPixel()

Uint32 CRM64Pro::GFX::getPixel	(	Sint32	iX,
		Sint32	iY,
		Sint32	idRes = `0`
	)

Get a pixel color.

Parameters

iX	X (horizontal) coordinate of the pixel.
iY	Y (vertical) coordinate of the pixel.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: a 32bits unsigned integer with the RGBA value of the pixel value.

Note: This method is a bit slow when accessing to an image handle or VERY slow when doing it on a screen.

◆ lineH() [1/2]

Sint32 CRM64Pro::GFX::lineH	(	Sint32	iX1,
		Sint32	iX2,
		Sint32	iY,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a horizontal line.

Parameters

iX1	X coordinate of the first point of the line.
iX2	X coordinate of the second point of the line.
iY	Y coordinate of the points of the line.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ lineH() [2/2]

Sint32 CRM64Pro::GFX::lineH	(	Sint32	iX1,
		Sint32	iX2,
		Sint32	iY,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a horizontal line.

Parameters

iX1	X coordinate of the first point of the line.
iX2	X coordinate of the second point of the line.
iY	Y coordinate of the points of the line.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ lineV() [1/2]

Sint32 CRM64Pro::GFX::lineV	(	Sint32	iX,
		Sint32	iY1,
		Sint32	iY2,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a vertical line.

Parameters

iX	X coordinate of the points of the line.
iY1	Y coordinate of the first point of the line.
iY2	Y coordinate of the second point of the line.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ lineV() [2/2]

Sint32 CRM64Pro::GFX::lineV	(	Sint32	iX,
		Sint32	iY1,
		Sint32	iY2,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a vertical line.

Parameters

iX	X coordinate of the points of the line.
iY1	Y coordinate of the first point of the line.
iY2	Y coordinate of the second point of the line.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ line() [1/2]

Sint32 CRM64Pro::GFX::line	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a line.

Parameters

iX1	X coordinate of the first point of the line.
iY1	Y coordinate of the first point of the line.
iX2	X coordinate of the second point of the line.
iY2	Y coordinate of the second point of the line.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ line() [2/2]

Sint32 CRM64Pro::GFX::line	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a line.

Parameters

iX1	X coordinate of the first point of the line.
iY1	Y coordinate of the first point of the line.
iX2	X coordinate of the second point of the line.
iY2	Y coordinate of the second point of the line.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rect() [1/2]

Sint32 CRM64Pro::GFX::rect	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw an outlined rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rect() [2/2]

Sint32 CRM64Pro::GFX::rect	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw an outlined rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rectFilled() [1/2]

Sint32 CRM64Pro::GFX::rectFilled	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a filled rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rectFilled() [2/2]

Sint32 CRM64Pro::GFX::rectFilled	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a filled rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rectRound() [1/2]

Sint32 CRM64Pro::GFX::rectRound	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Sint32	iRad,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a round outlined rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iRad	Radius in pixels of the corner arc.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rectRound() [2/2]

Sint32 CRM64Pro::GFX::rectRound	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Sint32	iRad,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a round outlined rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iRad	Radius in pixels of the corner arc.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rectFilledRound() [1/2]

Sint32 CRM64Pro::GFX::rectFilledRound	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Sint32	iRad,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a round filled rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iRad	Radius in pixels of the corner arc.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ rectFilledRound() [2/2]

Sint32 CRM64Pro::GFX::rectFilledRound	(	Sint32	iX1,
		Sint32	iY1,
		Sint32	iX2,
		Sint32	iY2,
		Sint32	iRad,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a round filled rectangle.

Parameters

iX1	X coordinate of the first point of the rectangle.
iY1	Y coordinate of the first point of the rectangle.
iX2	X coordinate of the second point of the rectangle.
iY2	Y coordinate of the second point of the rectangle.
iRad	Radius in pixels of the corner arc.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ arc() [1/2]

Sint32 CRM64Pro::GFX::arc	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRad,
		Sint32	iStart,
		Sint32	iEnd,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw an arc.

Parameters

iX	X coordinate of the center of the arc.
iY	Y coordinate of the center of the arc.
iRad	Radius in pixels of the arc.
iStart	Starting radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
iEnd	Ending radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ arc() [2/2]

Sint32 CRM64Pro::GFX::arc	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRad,
		Sint32	iStart,
		Sint32	iEnd,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw an arc.

Parameters

iX	X coordinate of the center of the arc.
iY	Y coordinate of the center of the arc.
iRad	Radius in pixels of the arc.
iStart	Starting radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
iEnd	Ending radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ circle() [1/2]

Sint32 CRM64Pro::GFX::circle	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRad,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw an outlined circle.

Parameters

iX	X coordinate of the center of the circle.
iY	Y coordinate of the center of the circle.
iRad	Radius in pixels of the circle.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ circle() [2/2]

Sint32 CRM64Pro::GFX::circle	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRad,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw an outlined circle.

Parameters

iX	X coordinate of the center of the circle.
iY	Y coordinate of the center of the circle.
iRad	Radius in pixels of the circle.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ circleFilled() [1/2]

Sint32 CRM64Pro::GFX::circleFilled	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRad,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a filled circle.

Parameters

iX	X coordinate of the center of the circle.
iY	Y coordinate of the center of the circle.
iRad	Radius in pixels of the circle.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ circleFilled() [2/2]

Sint32 CRM64Pro::GFX::circleFilled	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRad,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a filled circle.

Parameters

iX	X coordinate of the center of the circle.
iY	Y coordinate of the center of the circle.
iRad	Radius in pixels of the circle.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ ellipse() [1/2]

Sint32 CRM64Pro::GFX::ellipse	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRadX,
		Sint32	iRadY,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw an outlined ellipse.

Parameters

iX	X coordinate of the center of the ellipse.
iY	Y coordinate of the center of the ellipse.
iRadX	horizontal radius in pixels of the ellipse.
iRadY	vertical radius in pixels of the ellipse.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ ellipse() [2/2]

Sint32 CRM64Pro::GFX::ellipse	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRadX,
		Sint32	iRadY,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw an outlined ellipse.

Parameters

iX	X coordinate of the center of the ellipse.
iY	Y coordinate of the center of the ellipse.
iRadX	horizontal radius in pixels of the ellipse.
iRadY	vertical radius in pixels of the ellipse.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ ellipseFilled() [1/2]

Sint32 CRM64Pro::GFX::ellipseFilled	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRadX,
		Sint32	iRadY,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a filled ellipse.

Parameters

iX	X coordinate of the center of the ellipse.
iY	Y coordinate of the center of the ellipse.
iRadX	horizontal radius in pixels of the ellipse.
iRadY	vertical radius in pixels of the ellipse.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ ellipseFilled() [2/2]

Sint32 CRM64Pro::GFX::ellipseFilled	(	Sint32	iX,
		Sint32	iY,
		Sint32	iRadX,
		Sint32	iRadY,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a filled ellipse.

Parameters

iX	X coordinate of the center of the ellipse.
iY	Y coordinate of the center of the ellipse.
iRadX	horizontal radius in pixels of the ellipse.
iRadY	vertical radius in pixels of the ellipse.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ polygon() [1/2]

Sint32 CRM64Pro::GFX::polygon	(	Sint32 *	iVX,
		Sint32 *	iVY,
		Sint32	iNV,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw an outlined polygon.

Parameters

iVX	Vertex array containing X coordinates of the points of the polygon.
iVY	Vertex array containing Y coordinates of the points of the polygon.
iNV	Number of points in the vertex array. From a minimum number of 3 up to 32.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ polygon() [2/2]

Sint32 CRM64Pro::GFX::polygon	(	Sint32 *	iVX,
		Sint32 *	iVY,
		Sint32	iNV,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw an outlined polygon.

Parameters

iVX	Vertex array containing X coordinates of the points of the polygon.
iVY	Vertex array containing Y coordinates of the points of the polygon.
iNV	Number of points in the vertex array. From a minimum number of 3 up to 31.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ polygonFilled() [1/2]

Sint32 CRM64Pro::GFX::polygonFilled	(	Sint32 *	iVX,
		Sint32 *	iVY,
		Sint32	iNV,
		Uint32	iColor,
		Sint32	idRes = `0`
	)

Draw a filled polygon.

Parameters

iVX	Vertex array containing X coordinates of the points of the polygon.
iVY	Vertex array containing Y coordinates of the points of the polygon.
iNV	Number of points in the vertex array. From a minimum number of 3 up to 32.
iColor	The color value (0xRRGGBBAA).
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ polygonFilled() [2/2]

Sint32 CRM64Pro::GFX::polygonFilled	(	Sint32 *	iVX,
		Sint32 *	iVY,
		Sint32	iNV,
		Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8	iA,
		Sint32	idRes = `0`
	)

Draw a filled polygon.

Parameters

iVX	Vertex array containing X coordinates of the points of the polygon.
iVY	Vertex array containing Y coordinates of the points of the polygon.
iNV	Number of points in the vertex array. From a minimum number of 3 up to 32.
iR	The red color value.
iG	The green color value.
iB	The blue color value.
iA	The alpha value.
idRes	a valid screen or image handle. By default it tries to use the default screen.

Returns: 0 on success or a negative error code on failure.

◆ RGBtoHSV()

Sint32 CRM64Pro::GFX::RGBtoHSV	(	Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		float *	fH,
		float *	fS,
		float *	fV
	)

Color conversion from RGB to HSV.

Parameters

iR	Red component.
iG	Green component.
iB	Blue component.
fH	pointer to Hue component.
fS	pointer to Saturation component.
fV	pointer to Value component.

Returns: 0 on success or a negative error code on failure.

◆ HSVtoRGB()

Sint32 CRM64Pro::GFX::HSVtoRGB	(	float	fH,
		float	fS,
		float	fV,
		Uint8 *	iR,
		Uint8 *	iG,
		Uint8 *	iB
	)

Color conversion from HSV to RGB.

Parameters

fH	Hue component.
fS	Saturation component.
fV	Value component.
iR	pointer to Red component.
iG	pointer to Green component.
iB	pointer to Blue component.

Returns: 0 on success or a negative error code on failure.

◆ RGBtoYUV()

Sint32 CRM64Pro::GFX::RGBtoYUV	(	Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8 *	iY,
		Uint8 *	iU,
		Uint8 *	iV
	)

Color conversion from RGB to YUV.

Parameters

iR	Red component.
iG	Green component.
iB	Blue component.
iY	pointer to luma component.
iU	pointer to chrominance U component.
iV	pointer to chrominance V component.

Returns: 0 on success or a negative error code on failure.

◆ YUVtoRGB()

Sint32 CRM64Pro::GFX::YUVtoRGB	(	Uint8	iY,
		Uint8	iU,
		Uint8	iV,
		Uint8 *	iR,
		Uint8 *	iG,
		Uint8 *	iB
	)

Color conversion from YUV to RGB.

Parameters

iY	luma component.
iU	chrominance U component.
iV	chrominance V component.
iR	pointer to Red component.
iG	pointer to Green component.
iB	pointer to Blue component.

Returns: 0 on success or a negative error code on failure.

◆ RGBtoCMYK()

Sint32 CRM64Pro::GFX::RGBtoCMYK	(	Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8 *	iC,
		Uint8 *	iM,
		Uint8 *	iY,
		Uint8 *	iK
	)

Color conversion from RGB to CMYK.

Parameters

iR	Red component.
iG	Green component.
iB	Blue component.
iC	pointer to cyan component.
iM	pointer to magenta component.
iY	pointer to yellow component.
iK	pointer to key(black) component.

Returns: 0 on success or a negative error code on failure.

◆ CMYKtoRGB()

Sint32 CRM64Pro::GFX::CMYKtoRGB	(	Uint8	iC,
		Uint8	iM,
		Uint8	iY,
		Uint8	iK,
		Uint8 *	iR,
		Uint8 *	iG,
		Uint8 *	iB
	)

Color conversion from CMYK to RGB.

Parameters

iC	cyan component.
iM	magenta component.
iY	yellow component.
iK	key(black) component.
iR	pointer to Red component.
iG	pointer to Green component.
iB	pointer to Blue component.

Returns: 0 on success or a negative error code on failure.

◆ RGBtoYCC()

Sint32 CRM64Pro::GFX::RGBtoYCC	(	Uint8	iR,
		Uint8	iG,
		Uint8	iB,
		Uint8 *	iY,
		Uint8 *	Cb,
		Uint8 *	Cr
	)

Color conversion from RGB to YCC.

Parameters

iR	Red component.
iG	Green component.
iB	Blue component.
iY	pointer to luma component.
Cb	pointer to chrominance blue component.
Cr	pointer to chrominance red component.

Returns: 0 on success or a negative error code on failure.

◆ YCCtoRGB()

Sint32 CRM64Pro::GFX::YCCtoRGB	(	Uint8	iY,
		Uint8	Cb,
		Uint8	Cr,
		Uint8 *	iR,
		Uint8 *	iG,
		Uint8 *	iB
	)

Color conversion from YCC to RGB.

Parameters

iY	luma component.
Cb	chrominance blue component.
Cr	chrominance red component.
iR	pointer to Red component.
iG	pointer to Green component.
iB	pointer to Blue component.

Returns: 0 on success or a negative error code on failure.

Detailed Description

Classes

Functions

Function Documentation

◆ info()

◆ setSurfacePixel()

◆ getSurfacePixel()

◆ setPixel() [1/2]

◆ setPixel() [2/2]

◆ getPixel()

◆ lineH() [1/2]

◆ lineH() [2/2]

◆ lineV() [1/2]

◆ lineV() [2/2]

◆ line() [1/2]

◆ line() [2/2]

◆ rect() [1/2]

◆ rect() [2/2]

◆ rectFilled() [1/2]

◆ rectFilled() [2/2]

◆ rectRound() [1/2]

◆ rectRound() [2/2]

◆ rectFilledRound() [1/2]

◆ rectFilledRound() [2/2]

◆ arc() [1/2]

◆ arc() [2/2]

◆ circle() [1/2]

◆ circle() [2/2]

◆ circleFilled() [1/2]

◆ circleFilled() [2/2]

◆ ellipse() [1/2]

◆ ellipse() [2/2]

◆ ellipseFilled() [1/2]

◆ ellipseFilled() [2/2]

◆ polygon() [1/2]

◆ polygon() [2/2]

◆ polygonFilled() [1/2]

◆ polygonFilled() [2/2]

◆ RGBtoHSV()

◆ HSVtoRGB()

◆ RGBtoYUV()

◆ YUVtoRGB()

◆ RGBtoCMYK()

◆ CMYKtoRGB()

◆ RGBtoYCC()

◆ YCCtoRGB()