<HTML>
	<HEAD>
		<TITLE>Reference manual for David Piuva's graphics engine</TITLE>
	</HEAD>
	<BODY>
		<link rel="stylesheet" type="text/css" href="PageStyle.css">
		<A href="../Manual.html">Back to main page</A>
<P>		<b>CPU surface</b>
<P>	This collection was made for storing a copy of a draw surface that you need to access from both the graphics card and the CPU while you make small modifications.
<P>	Each CPU buffer has a staging buffer on the graphic card's memory and a vector array on the CPU's memory. Therefor, this way to read pixel data takes a lot of memory if you make a complete copy of a large draw surface.
<P>	<IMG SRC="Images/Border.png">
<P>		<IMG SRC="Images/Star.png"> int CPUSurface_CreateFixed(int newWidth, int newHeight, float Red, float Green, float Blue, float Alpha);
<P>			newWidth is the number of pixel columns.
<P>			newHeight is the number of pixel rows.
<P>			(Red,Green,Blue,Alpha) is the initial color.
<P>			<IMG SRC="Images/PreCondition.png"> 0 < newWidth ≤ 8192, 0 < newHeight ≤ 8192
<P>			<IMG SRC="Images/PostCondition.png"> Returns the ID to the new CPU surface.
<P>			<IMG SRC="Images/SideEffect.png"> Creates a new CPU surface of dimensions newWidth * newHeight where each pixel has the color (Red,Green,Blue,Alpha).
<P>	<IMG SRC="Images/Border.png">
<P>		<IMG SRC="Images/Trashcan.png"> void CPUSurface_Delete(int CPUSurface);
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface.
<P>			<IMG SRC="Images/SideEffect.png"> The CPU surface refered to by CPUSurface is deleted.
<P>	<IMG SRC="Images/Border.png">
<P>		<IMG SRC="Images/LeftArrow.png"> int CPUSurface_GetWidth(int CPUSurface);
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface.
<P>			<IMG SRC="Images/PostCondition.png"> The width of the CPU surface refered to by CPUSurface.
<P>	<IMG SRC="Images/LightBorder.png">
<P>		<IMG SRC="Images/LeftArrow.png"> int CPUSurface_GetHeight(int CPUSurface);
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface.
<P>			<IMG SRC="Images/PostCondition.png"> The height of the CPU surface refered to by CPUSurface.
<P>	<IMG SRC="Images/Border.png">
<P>		<IMG SRC="Images/RightArrow.png"> void CPUSurface_FillWithColor(int CPUSurface, float Red, float Green, float Blue, float Alpha);
<P>			This method does exactly the same thing as DrawSurface_FillWithColor.
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface.
<P>			<IMG SRC="Images/SideEffect.png"> All pixels in CPUSurface is set to the color (Red,Green,Blue,Alpha).
<P>	<IMG SRC="Images/Border.png">
<P>		<IMG SRC="Images/LeftArrow.png"> void CPUSurface_GetPixelColor_Clamped_OutV4(int CPUSurface, int X, int Y);
<P>			The content is stored in the interval [0..Width-1],[0..Height-1] and taking a pixel from outside will take the color from the closest pixel inside the bound.
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface.
<P>			<IMG SRC="Images/SideEffect.png"> The RGBA color from CPUSurface at X,Y is stored in (X1,Y1,Z1,W1).
<P>	<IMG SRC="Images/LightBorder.png">
<P>		<IMG SRC="Images/LeftArrow.png"> void CPUSurface_GetPixelColor_Border_OutV4(int CPUSurface, int X, int Y, float DefaultRed, float DefaultGreen, float DefaultBlue, float DefaultAlpha);
<P>			The content is stored in the interval [0..Width-1],[0..Height-1] and taking a pixel from outside will take the color that you gave as default.
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface.
<P>			<IMG SRC="Images/SideEffect.png"> The RGBA color from CPUSurface at X,Y is stored in (X1,Y1,Z1,W1) but if X,Y is out of bound, (DefaultRed,DefaultGreen,DefaultBlue,DefaultAlpha) is written instead.
<P>	<IMG SRC="Images/LightBorder.png">
<P>		<IMG SRC="Images/RightArrow.png"> void CPUSurface_SetPixelColor_Ignore(int CPUSurface, int X, int Y, float Red, float Green, float Blue, float Alpha);
<P>			This method will set the pixel if X,Y is inside the bound and ignore any calls trying to set it out of bound.
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface. If you want something to happend, X,Y must be inside the bound [0..Width-1],[0..Height-1].
<P>			<IMG SRC="Images/SideEffect.png"> If X,Y is inside the bound [0..Width-1],[0..Height-1], the RGBA color in CPUSurface at X,Y is set to (Red,Green,Blue,Alpha).
<P>	<IMG SRC="Images/Border.png">
<P>		<IMG SRC="Images/RightArrow.png"> void CPUSurface_CopyRectFromDrawSurface(int Input_DrawSurface, int Output_CPUSurface, int SourceLeft, int SourceTop, int DestLeft, int DestTop, int Width, int Height);
<P>			<IMG SRC="Images/Warning.png"> This call is even slower than DrawSurface_GetPixelColor_OutV4 but don't have to be called every time you sample a pixel and is therefor much faster to use if you only copy modified regions of a draw surface.
<P>			<IMG SRC="Images/PreCondition.png"> CPUSurface is a valid CPU surface and the 2 rectangles for source and destination must be inside of the bounds.
<P>			<IMG SRC="Images/SideEffect.png"> A rectangle from [SourceLeft..SourceLeft + Width - 1],[SourceTop..SourceTop + Height - 1] in Input_DrawSurface is loaded to [DestLeft..DestLeft + Width - 1],[DestTop..DestTop + Height - 1] in Output_CPUSurface.
<P>	<IMG SRC="Images/Border.png">
	</BODY>
</HTML>