Bliting Surfaces, Animations and Fonts and setting the transformations directly
[Advances methods for bliting directly to the screen without using entities. It uses IND_Render methods (recommended only for advanced IndieLib users)]

Advanced 2d bliting methods (it's preferible to use IND_Entity2d together with IND_Entity2dManager instead)
void	IND_Render::BlitSurface (IND_Surface *pSu)
void	IND_Render::BlitGrid (IND_Surface *pSu, byte pR, byte pG, byte pB, byte pA)
bool	IND_Render::BlitRegionSurface (IND_Surface *pSu, int pX, int pY, int pWidth, int pHeight)
bool	IND_Render::BlitWrapSurface (IND_Surface *pSu, int pWidth, int pHeight, float pUDisplace, float pVDisplace)
int	IND_Render::BlitAnimation (IND_Animation *pAn, int pSequence, int pX, int pY, int pWidth, int pHeight, bool pToggleWrap, float pUDisplace, float pVDisplace)
void	IND_Render::BlitText (IND_Font *pFo, char *pText, int pX, int pY, int pOffset, int pLineSpacing, byte pR, byte pG, byte pB, byte pA, byte pFadeR, byte pFadeG, byte pFadeB, byte pFadeA, IND_Filter pFilter, IND_BlendingType pSo, IND_BlendingType pDs, IND_Align pAlign)
Advanced transformations methods (it's preferible to use IND_Entity2d and IND_Entity3d instead)
void	IND_Render::SetTransform2d (int pX, int pY, float pAngleX, float pAngleY, float pAngleZ, float pScaleX, float pScaleY, int pAxisCalX, int pAxisCalY, bool pMirrorX, bool pMirrorY, int pWidth, int pHeight, IND_Matrix *pMatrix)
void	IND_Render::SetRainbow2d (IND_Type pType, bool pCull, bool pMirrorX, bool pMirrorY, IND_Filter pFilter, byte pR, byte pG, byte pB, byte pA, byte pFadeR, byte pFadeG, byte pFadeB, byte pFadeA, IND_BlendingType pSo, IND_BlendingType pDs)
void	IND_Render::SetTransform3d (float pX, float pY, float pZ, float pAngleX, float pAngleY, float pAngleZ, float pScaleX, float pScaleY, float pScaleZ, IND_Matrix *pMatrix)
void	IND_Render::SetRainbow3d (bool pCull, bool pFlipNormals, IND_Filter pFilter, byte pR, byte pG, byte pB, byte pA, byte pFadeR, byte pFadeG, byte pFadeB, byte pFadeA, IND_BlendingType pSo, IND_BlendingType pDs)
void	IND_Render::LookAt (float pEyeX, float pEyeY, float pEyeZ, float pLookAtX, float pLookAtY, float pLookAtZ, float pUpX, float pUpY, float pUpZ)
void	IND_Render::PerspectiveFov (float pFov, float pAspect, float pNearClippingPlane, float pFarClippingPlane)
void	IND_Render::PerspectiveOrtho (float pWidth, float pHeight, float pNearClippingPlane, float pFarClippingPlane)

---

Detailed Description

With these methods you can set the 2d transformations (using IND_Render::Set2dTransform) and color attributes (using IND_Render::SetRainbow()) and to blit directly to the screen surfaces, animations, and fonts using IND_Render class.

Remember that you can use IND_Entity2d together with IND_Entity2dManager for drawing these graphical objects to the screen without having to use this advanced methods directly. This method are only useful for advanced users for really concrete purposes.

---

Function Documentation

void IND_Render::BlitSurface

(

IND_Surface *

pSu

)

[inline, inherited]

Parameters:

• pSu Pointer to a IND_Surface object

Operation:

This function blits directly to the screen a IND_Surface object.

In order to change the transformations and color attributes of the surface you have to use the IND_Render::SetTransform2d() and IND_Render::SetRainbow2d() methods before calling to this function. Remember that you can use IND_Entity2d object for drawing surfaces to the screen without having to use this advanced methods directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use:

• IND_Entity2d::SetSurface()

void IND_Render::BlitGrid	(	IND_Surface *	pSu,
		byte	pR,
		byte	pG,
		byte	pB,
		byte	pA
	)			[inline, inherited]

Parameters:

• pSu Pointer to a IND_Surface object

Operation:

This function blits directly to the screen the grid of an IND_Surface object.

This method is equivalent to use:

• IND_Entity2dManager::RenderGridAreas()
• IND_Entity2d::ShowGridAreas()

bool IND_Render::BlitRegionSurface	(	IND_Surface *	pSu,
		int	pX,
		int	pY,
		int	pWidth,
		int	pHeight
	)			[inline, inherited]

Parameters:

• pSu Pointer to a IND_Surface object
• pX, pY Upper left coordinate of the region
• pWidth, pHeight Width and Height of the region

Operation:

This function returns 1 (true) if it blits directly to the screen a region of a IND_Surface object.

This method is useful when we want to render only a certain region of a IND_Surface.

If the region that we chose is out of the range of the sprite, the function will return false and no region will be rendered.

Special remark: this function only works with IND_Surface objects that only have ONE texture assigned (you can check this using::IND_Surface::GetNumTextures() method). So, it will work only with images that are power of two and lower than the maximum texture size allowed by your card (you can check this parameter using IND_Render::GetMaxTextureSize()). The method will return 0 otherwise.

In order to change the transformations and color attributes of the surface you have to use the IND_Render::SetTransform2d() and IND_Render::SetRainbow2d() methods before calling to this function. Remember that you can use IND_Entity2d object for drawing surfaces to the screen without having to use this advanced methods directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetSurface()
• IND_Entity2d::SetRegion()

bool IND_Render::BlitWrapSurface	(	IND_Surface *	pSu,
		int	pWidth,
		int	pHeight,
		float	pUDisplace,
		float	pVDisplace
	)			[inline, inherited]

Parameters:

• pSu Pointer to a IND_Surface object
• pX, pY Upper left coordinate of the region
• pWidth, pHeight Width and Height of the region
• pUDisplace, pVDisplace Horizontal and vertical displacement of the image

Operation:

This function returns 1 (true) if it blits directly to the screen a IND_Surface object tiling it both in X and Y coordinates.

This method is useful when we want to render a tiled texture or background.

Special remark: this function only works with IND_Surface objects that only have ONE texture assigned (you can check this using::IND_Surface::GetNumTextures() method). So, it will work only with images that are power of two and lower than the maximum texture size allowed by your card (you can check this parameter using IND_Render::GetMaxTextureSize()). The method will return 0 otherwise.

In order to change the transformations and color attributes of the surface you have to use the IND_Render::SetTransform2d() and IND_Render::SetRainbow2d() methods before calling to this function. Remember that you can use IND_Entity2d object for drawing surfaces to the screen without having to use this advanced methods directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetSurface()
• IND_Entity2d::SetRegion()
• IND_Entity2d::ToggleWrap()
• IND_Entity2d::SetWrapDisplacement()

int IND_Render::BlitAnimation	(	IND_Animation *	pAn,
		int	pSequence,
		int	pX,
		int	pY,
		int	pWidth,
		int	pHeight,
		bool	pToggleWrap,
		float	pUDisplace,
		float	pVDisplace
	)			[inline, inherited]

Parameters:

• pAn Pointer to a IND_Animation object
• pSequence Number of the sequence to blit (the first sequence is 0)
• pX, pY Upper left coordinate of the region
• pWidth, pHeight Width and Height of the region
• pToggleWrap Wraping on (1) / off (0)
• pUDisplace, pVDisplace Horizontal and vertical displacement of the image

Operation:

This function blits directly to the screen a certain sequence of a IND_Animation object.

Each frame of the animation will be blited to the screen the number of milliseconds that are defined in the animation script file. The sequecen starts in the frame 0 and finishes in the last frame specefied in the animation script. The animation will be displayed only one time, after that it will stop in the last frame (bliting it permanently).

This functions returns -1 when the animation finishes, 0 if there is any error (for example trying to blit an invalid IND_Animation pointer) and 1 if is in the middle of the animation and there are no errors.

In order to change the transformations and color attributes of the animation you have to use the IND_Render::SetTransform2d() and IND_Render::SetRainbow2d() methods before calling to this function. Remember that you can use IND_Entity2d object for drawing animations to the screen without having to use this advanced methods directly. This method is only useful for advanced users for really concrete purposes.

Special remark: if you specify a region this function only works with IND_Surface objects that only have ONE texture assigned (you can check this using::IND_Surface::GetNumTextures() method). So, it will work only with images that are power of two and lower than the maximum texture size allowed by your card (you can check this parameter using IND_Render::GetMaxTextureSize()). The method will return 0 otherwise.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetAnimation()
• IND_Entity2d::SetRegion()
• IND_Entity2d::ToggleWrap()
• IND_Entity2d::SetWrapDisplacement()

void IND_Render::BlitText	(	IND_Font *	pFo,
		char *	pText,
		int	pX,
		int	pY,
		int	pOffset,
		int	pLineSpacing,
		byte	pR,
		byte	pG,
		byte	pB,
		byte	pA,
		byte	pFadeR,
		byte	pFadeG,
		byte	pFadeB,
		byte	pFadeA,
		IND_Filter	pLinearFilter,
		IND_BlendingType	pSo,
		IND_BlendingType	pDs,
		IND_Align	pAlign
	)			[inline, inherited]

Parameters:

• pFo Pointer to a IND_Font object
• pText Text to write to the screen
• pX, pY Position
• pOffset Char spacing
• pLineSpacing Line spacing
• pR, pG, pB R, G, B components of the tinting color
• pA Transparency level. (255 = complety opaque)
• pFadeR, pFadeG, pFadeB, pFadeA Fade to a color.
• pFilter IND_Filter type
• pSo Source blending, see (IND_BlendingType).
• pDs Destiny blending, see (IND_BlendingType).
• pAlign Text alignment, see::IND_Align.

Operation:

This function blits directly to the screen a text using IND_Font object.

Important: you can not change the transformation or color attributes of the font using IND_Render::SetTransform2d() or IND_Render::SetRainbow().

Remember that you can use IND_Entity2d object for drawing fonts to the screen without having to use this advanced methods directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetFont()
• IND_Entity2d::SetPosition()
• IND_Entity2d::SetText()
• IND_Entity2d::SetCharSpacing()
• IND_Entity2d::SetLineSpacing()
• IND_Entity2d::SetAlign()

void IND_Render::SetTransform2d	(	int	pX,
		int	pY,
		float	pAngleX,
		float	pAngleY,
		float	pAngleZ,
		float	pScaleX,
		float	pScaleY,
		int	pAxisCalX,
		int	pAxisCalY,
		bool	pMirrorX,
		bool	pMirrorY,
		int	pWidth,
		int	pHeight,
		IND_Matrix *	pMatrix
	)			[inline, inherited]

Parameters:

• pX Translation in the X coordinate. The (0, 0) position is the upper-left corner of the Viewport
• pY Translation in the Y coordinate. The (0, 0) position is the upper-left corner of the Viewport
• pAngleX Rotation in the angle x in degrees
• pAngleY Rotation in the angle y in degrees
• pAngleZ Rotation in the angle z in degrees
• pScaleX Scaling in the x coordinate. 1 for maintaining the original size
• pScaleY Scaling in the y coordinate. 1 for maintaining the original size
• pAxisCalX, pAxisCalY Parameters that indicates the displacement that the graphical object suffer due to the HotSpot. If the HotSpot is not specified, the valued should be 0 for both of them. All the transformation will be aplied from the upper-left corner of the object.
• pMirrorX Horizontal mirroring. (true / false) = (activated / deactivated).
• pMirrorY Vertical mirroring. (true / false) = (activated / deactivated).
• pWidth Width of the graphical object that we are going to blit just after applying the transformation. You shoud use the GetWidth() method of the object.
• pHeight Height of the graphical object that we are going to blit just after applying the transformation. You shoud use the GetHeight() method of the object.
• pMatrix Pointer to a IND_Matrix matrix. In this parameter will be returned by reference the world matrix transformation that will be aplied to the graphical object. This matrix can be useful for advanced programmers that need the algebraic description of the transformation done. It is possible to use the value 0 if it not necessary to have this matrix information. Operation:

This function sets the 2d transformation (translation, rotation, scaling, mirroring and hotspot) of the following 2d graphical objects that will be rendered by the engine. You should use this method before calling to any of the Bliting methods.

Remember that you can use IND_Entity2d object for applying 2d transformations to the graphical objects without having to use this advanced method directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetAnimation()
• IND_Entity2d::SetSurface()
• IND_Entity2d::SetPrimitive2d()
• IND_Entity2d::SetFont()
• IND_Entity2d::SetPosition()
• IND_Entity2d::SetAngleXYZ()
• IND_Entity2d::SetScale()
• IND_Entity2d::SetBackCull()
• IND_Entity2d::SetMirrorX()
• IND_Entity2d::SetMirrorY()
• IND_Entity2d::SetFilter()
• IND_Entity2d::SetHotSpot()
• IND_Entity2d::SetRegion()
• IND_Entity2d::ToggleWrap()

void IND_Render::SetRainbow2d	(	IND_Type	pType,
		bool	pCull,
		bool	pMirrorX,
		bool	pMirrorY,
		IND_Filter	pFilter,
		byte	pR,
		byte	pG,
		byte	pB,
		byte	pA,
		byte	pFadeR,
		byte	pFadeG,
		byte	pFadeB,
		byte	pFadeA,
		IND_BlendingType	pSo,
		IND_BlendingType	pDs
	)			[inline, inherited]

Parameters:

• pType IND_Type type of the following graphical object.
• pCull Backface culling. (true / false) = (on / off). This parameter can be deactivated when we are going to rotate the graphical object in the x or y coordinates. This feature can be deactivated when we are going to rotate the graphical object in the x or y coordinates. This way it is possible to draw for example the leaf of a tree that falls down rotating and showing both faces. In any other case this parameter must be activated for faster rendering times preventing the hardware from drawing back faces.
• pMirrorX Horizontal mirroring. (true / false) = (activated / deactivated).
• pMirrorY Vertical mirroring. (true / false) = (activated / deactivated).
• pFilter Type of filter IND_Filter. There are two types of filters that can be applied to the graphical object when it suffers a rotation or scaling:
  • IND_FILTER_POINT (Nearest point filter). Less quality, but bigger performance. It is possible to use this one without quality loss in graphical objects that don't rotate or are affected by scaling.
  • IND_FILTER_LINEAR (Bilinear filter). More quality, but less performance. Used in graphical objects that be rotated or affected by scaling.
• pR, pG, pB Color bytes FadeR, FadeG, FadeB for making a fade of the image to a certain color. When we speak of fade we refer to the progressive change of an image to certain color. For example, if we use RGB = (255, 0, 0), the image will be faded to red color.
• pA The A byte indicates the level of transparency. If a value 0 is used, the following graphical object will be completely transparent, opposite to the value 255 that will be drawn completely opaque. It is possible to use all the intermediate values for different levels of transparency.
• pFadeR, pFadeG, pFadeB, pFadeA Bytes FadeR, FadeG, FadeB for making a fade of the image to a certain color. When we speak of fade we refer to the progressive change of an image to certain color. For example, if we use RGB = (255, 0, 0), the image will be faded to red color.
• pSo Indicates the blending source, see (IND_BlendingType).
• pDs Indicates the blending destiny, see (IND_BlendingType).

Operation:

This functions sets the color and blending attributes of the following graphical object. It should be used before any calling to the Blit methods.

Important: It is not possible to use tinting and fading at the same time, the fade will prevail upon the tinting.

Remember that you can use IND_Entity2d objects for applying color transformations to the graphical objects without having to use this advanced method directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetTransparency()
• IND_Entity2d::SetFade()
• IND_Entity2d::SetTint()
• IND_Entity2d::SetBlendSource()
• IND_Entity2d::SetBlendDest()

void IND_Render::SetTransform3d	(	float	pX,
		float	pY,
		float	pZ,
		float	pAngleX,
		float	pAngleY,
		float	pAngleZ,
		float	pScaleX,
		float	pScaleY,
		float	pScaleZ,
		IND_Matrix *	pMatrix
	)			[inline, inherited]

Parameters:

• pX Translation in the X coordinate.
• pY Translation in the Y coordinate.
• pZ Translation in the Z coordinate.
• pAngleX Rotation in the angle x in degrees
• pAngleY Rotation in the angle y in degrees
• pAngleZ Rotation in the angle z in degrees
• pScaleX Scaling in the x coordinate. 1 for maintaining the original size
• pScaleY Scaling in the y coordinate. 1 for maintaining the original size
• pScaleZ Scaling in the z coordinate. 1 for maintaining the original size
• pMatrix Pointer to a IND_Matrix matrix. In this parameter will be returned by reference the world matrix transformation that will be aplied to the graphical object. This matrix can be useful for advanced programmers that need the algebraic description of the transformation done. It is possible to use the value 0 if it not necessary to have this matrix information. Operation:

This function sets the 3d transformation (translation, rotation, scaling and mirroring) of the following 3d graphical objects that will be rendered by the engine. You should use this method before calling to any of the Bliting methods.

Remember that you can use IND_Entity3d object for applying 3d transformations to the graphical objects without having to use this advanced method directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity3d::Set3dMesh()
• IND_Entity3d::SetPosition()
• IND_Entity3d::SetAngleXYZ()
• IND_Entity3d::SetScale()
• IND_Entity2d::SetBackCull()
• IND_Entity2d::SetFilter()

void IND_Render::SetRainbow3d	(	bool	pCull,
		bool	pFlipNormals,
		IND_Filter	pFilter,
		byte	pR,
		byte	pG,
		byte	pB,
		byte	pA,
		byte	pFadeR,
		byte	pFadeG,
		byte	pFadeB,
		byte	pFadeA,
		IND_BlendingType	pSo,
		IND_BlendingType	pDs
	)			[inline, inherited]

Parameters:

• pCull Backface culling. (true / false) = (on / off). This parameter can be deactivated when we are going to go inside a 3dMesh and we want to render both faces of the polygons.In any other case this parameter must be activated for faster rendering times preventing the hardware from drawing back faces.
• pFilter Type of filter IND_Filter. There are two types of filters that can be applied to the graphical object when it suffers a rotation or scaling:
  • IND_FILTER_POINT (Nearest point filter). Less quality, but bigger performance. It is possible to use this one without quality loss in graphical objects that don't rotate or are affected by scaling.
  • IND_FILTER_LINEAR (Bilinear filter). More quality, but less performance. Used in graphical objects that be rotated or affected by scaling.
• pR, pG, pB Color bytes FadeR, FadeG, FadeB for making a fade of the image to a certain color. When we speak of fade we refer to the progressive change of an image to certain color. For example, if we use RGB = (255, 0, 0), the image will be faded to red color.
• pA The A byte indicates the level of transparency. If a value 0 is used, the following graphical object will be completely transparent, opposite to the value 255 that will be drawn completely opaque. It is possible to use all the intermediate values for different levels of transparency.
• pFadeR, pFadeG, pFadeB, pFadeA Bytes FadeR, FadeG, FadeB for making a fade of the image to a certain color. When we speak of fade we refer to the progressive change of an image to certain color. For example, if we use RGB = (255, 0, 0), the image will be faded to red color.
• pSo Indicates the blending source, see (IND_BlendingType).
• pDs Indicates the blending destiny, see (IND_BlendingType).

Operation:

This functions sets the color and blending attributes of the following graphical object. It should be used before any calling to the Blit methods.

Important: It is not possible to use tinting and fading at the same time, the fade will prevail upon the tinting.

Remember that you can use IND_Entity2d objects for applying color transformations to the graphical objects without having to use this advanced method directly. This method is only useful for advanced users for really concrete purposes.

This method is equivalent to use a combination of this methods:

• IND_Entity2d::SetTransparency()
• IND_Entity2d::SetFade()
• IND_Entity2d::SetTint()
• IND_Entity2d::SetBlendSource()
• IND_Entity2d::SetBlendDest()

void IND_Render::LookAt	(	float	pEyeX,
		float	pEyeY,
		float	pEyeZ,
		float	pLookAtX,
		float	pLookAtY,
		float	pLookAtZ,
		float	pUpX,
		float	pUpY,
		float	pUpZ
	)			[inline, inherited]

Parameters:

• pEyeX, pEyeY, pEyeZ Position of the camera
• pLookAtX, pLookAtY, pLookAtZ Vector defining the direction of the camera
• pUpX, pUpY, pUpZ Vector "up" of the camera.

Operation:

This function sets a perspective matrix trought the definition of a position and two vectors (lookat and up).

This method is equivalent to use a combination of methods of the class SetCamera3d().

void IND_Render::PerspectiveFov	(	float	pFov,
		float	pAspect,
		float	pNearClippingPlane,
		float	pFarClippingPlane
	)			[inline, inherited]

Parameters:

• pFov Vertical fov
• pAspect Aspect ratio (usually the with of the viewport divided by the height)
• pNearClippingPlane Near clipping plane
• pFarClippingPlane Far clipping plane

Operation:

This function sets a fov projection matrix.

This method is equivalent to use a combination of methods of the class SetCamera3d().

void IND_Render::PerspectiveOrtho	(	float	pWidth,
		float	pHeight,
		float	pNearClippingPlane,
		float	pFarClippingPlane
	)			[inline, inherited]

Parameters:

• pWidth Width
• pHeight Height
• pNearClippingPlane Near clipping plane
• pFarClippingPlane Far clipping plane

Operation:

This function sets a orthographic projection matrix.

This method is equivalent to use a combination of methods of the class SetCamera3d().

---