RmGfxUtilD3D.h File Reference

#include <GfxUtil/RmGfxUtilTypes.h>

Go to the source code of this file.

Classes
class	RmD3DHLSLIncludeInterface
Functions
RMGFXUTIL_API D3DFORMAT	RmGfxToD3DFormat (RmPixelFormatType format)
	Conversion from RenderMonkey pixel format into D3D format.
RMGFXUTIL_API RmPixelFormatType	RmGfxFromD3DFormat (D3DFORMAT format)
	Conversion from D3D format into RenderMonkey pixel format.
RMGFXUTIL_API IDirect3DDevice9 *	RmGfxGetD3DDevice ()
	Retrieve graphics utility library D3D device.
RMGFXUTIL_API D3DDEVTYPE	RmGfxGetD3DDeviceType ()
	Retrieve graphics utilities library D3D device.
RMGFXUTIL_API IDirect3D9 *	RmGfxGetD3D ()
	Retrieve a pointer to a static D3D instance.
RMGFXUTIL_API D3DDISPLAYMODE	RmGfxGetD3DDisplayMode ()
	Retrieve display mode for D3D used by graphics utility library.
RMGFXUTIL_API bool	RmGfxSetD3DSurface (IDirect3DSurface9 *pDestSurface, RmSurface *pSrcSurface, bool bNeedToFlip)
	Copies contents of a RenderMonkey texture surface to D3D surface.
RMGFXUTIL_API bool	RmGfxSetRmSurface (RmSurface *pDestSurface, IDirect3DSurface9 *pSrcSurface, bool bNeedToFlip)
	Copies contents of D3D surface to a RenderMonkey texture surface.
RMGFXUTIL_API bool	RmGfxSetD3DVolume (IDirect3DVolume9 *pDestVolume, RmVolume *pSrcVolume, bool bNeedToFlip)
	Copies contents of D3D volume to a RenderMonkey volume texture.
RMGFXUTIL_API bool	RmGfxSetRmVolume (RmVolume *pDestVolume, IDirect3DVolume9 *pSrcVolume, bool bNeedToFlip)
	Copies contents of a RenderMonkey volume texture to D3D volume.
RMGFXUTIL_API void	RmGfxConvertMatrix (RmMatrix4x4 &refDestMatrix, const D3DXMATRIX &refSrcMatrix)
	Convert a D3D matrix to a RenderMonkey matrix.
RMGFXUTIL_API void	RmGfxConvertMatrix (D3DXMATRIX &refDestMatrix, const RmMatrix4x4 &refSrcMatrix)
	Convert a RenderMonkey matrix to a D3D matrix.
RMGFXUTIL_API bool	RmGfxSetD3DTexture (IDirect3DBaseTexture9 *pDestTexture, RmTexture *pSrcTexture, bool bNeedToFlip)
	Copies contents of a RenderMonkey texture surface to D3D surface.
RMGFXUTIL_API bool	RmGfxSaveToXFile (const RM_TCHAR *szFileName, RmModelData *pModelData)
	Save geometry model data to a .X file.
RMGFXUTIL_API bool	RmGfxDoesFormatHaveStencilBuffer (DWORD dwFormat)
	Checks whether a given stencil format supports stencil buffer.
RMGFXUTIL_API RmD3DHLSLIncludeInterface *	RmGetHLSLIncludeInterface ()
	Accessor for HLSL include interface instance.

---

Detailed Description

Direct3D related Graphics utilities

---

Function Documentation

RMGFXUTIL_API RmD3DHLSLIncludeInterface* RmGetHLSLIncludeInterface (   )

Accessor for HLSL include interface instance. Provides an accessor to the singleton instance of an HLSL include file interface. Returns: RmD3DHLSLIncludeInterface* A pointer to the include interface instance

RMGFXUTIL_API void RmGfxConvertMatrix (  D3DXMATRIX &  refDestMatrix, const RmMatrix4x4 &  refSrcMatrix )

Convert a RenderMonkey matrix to a D3D matrix. This method converts a RenderMonkey matrix to a D3D matrix type data Parameters: refSrcMatrix  RenderMonkey 4x4 matrix instance refDestMatrix  D3D Matrix instance See also: refDestMatrix Returns: None

RMGFXUTIL_API void RmGfxConvertMatrix (  RmMatrix4x4 &  refDestMatrix, const D3DXMATRIX &  refSrcMatrix )

Convert a D3D matrix to a RenderMonkey matrix. This method converts a D3D matrix to a RenderMonkey matrix type data Parameters: refSrcMatrix  RenderMonkey 4x4 matrix instance See also: RmMatrix4x4 Parameters: refDestMatrix  D3D Matrix instance Returns: None

RMGFXUTIL_API bool RmGfxDoesFormatHaveStencilBuffer (  DWORD  dwFormat  )

Checks whether a given stencil format supports stencil buffer. Checks whether the specified depth buffer format supports stencil buffer Parameters: dwFormat  Depth / Stencil buffer format to check Returns: True if a given format allows creation of stencil buffer, false otherwise

RMGFXUTIL_API RmPixelFormatType RmGfxFromD3DFormat (  D3DFORMAT  format  )

Conversion from D3D format into RenderMonkey pixel format. Converts D3D pixel format value into RenderMonkey pixel format value Parameters: format  D3D pixel format value Returns: Converted RenderMonkey pixel format value See also: RmPixelFormatType

RMGFXUTIL_API IDirect3D9* RmGfxGetD3D (   )

Retrieve a pointer to a static D3D instance. Provides a pointer to a static D3D. It is created at start-time and it is associated with a hidden window. Returns: A pointer to the D3D

RMGFXUTIL_API IDirect3DDevice9* RmGfxGetD3DDevice (   )

Retrieve graphics utility library D3D device. Provides a pointer to a static D3D device. This device is created at start-time and it is associated with a hidden window, thus it is a reference rasterizer device only. But it can be used for miscellaneous tasks using D3DX library or otherwise (not for rendering). Returns: A pointer to the D3D device

RMGFXUTIL_API D3DDEVTYPE RmGfxGetD3DDeviceType (   )

Retrieve graphics utilities library D3D device. Retrieves the device type for the D3D device used by the graphics library Returns: Device type

RMGFXUTIL_API D3DDISPLAYMODE RmGfxGetD3DDisplayMode (   )

Retrieve display mode for D3D used by graphics utility library. Returns the D3D display mode for the RenderMonkey utility device Returns: device mode

RMGFXUTIL_API bool RmGfxSaveToXFile (  const RM_TCHAR *  szFileName, RmModelData *  pModelData )

Save geometry model data to a .X file. This method saves a specified model in 'pModelData' node to the 'szFileName' file. Returns true if no errors were encountered during the process of saving the data, false otherwise. Parameters: szFileName  Depth / Stencil buffer format to check pModelData  Input model to save to file See also: RmModelData Returns: True if no errors were encountered during save, false otherwise

RMGFXUTIL_API bool RmGfxSetD3DSurface (  IDirect3DSurface9 *  pDestSurface, RmSurface *  pSrcSurface, bool  bNeedToFlip )

Copies contents of a RenderMonkey texture surface to D3D surface. This method copies the contents of a texture surface from the input RenderMonkey texture surface into a D3D texture surface. Note that prior to calling this method, the D3D texture surface _must_ be created with matching dimensions and pixel format. Parameters: pDestVolume  - destination D3D texture surface pSrcVolume  - input RenderMonkey texture surface See also: RmSurface Returns: True if successfully copied the texture, false otherwise (if any errors were encountered.

RMGFXUTIL_API bool RmGfxSetD3DTexture (  IDirect3DBaseTexture9 *  pDestTexture, RmTexture *  pSrcTexture, bool  bNeedToFlip )

Copies contents of a RenderMonkey texture surface to D3D surface. This method copies the contents of texture data from the input RenderMonkey texture into a D3D texture. Note that the destination D3D texture must be pre-allocated with correct dimensions matching the input RenderMonkey texture (including cubemaps and volume textures) Parameters: pDestTexture  DirectX destination texture to received copied texture data pSrcTexture  RenderMonkey texture surface See also: RmTexture Returns: True if no errors were encountered during copying texture data, false otherwise

RMGFXUTIL_API bool RmGfxSetD3DVolume (  IDirect3DVolume9 *  pDestVolume, RmVolume *  pSrcVolume, bool  bNeedToFlip )

Copies contents of D3D volume to a RenderMonkey volume texture. This method copies the contents of a volume texture from the input RenderMonkey volume texture into a D3D volume texture. Note that the D3D volume must be created with the same dimensions prior to calling this function as well as with a matching surface format. Parameters: pDestVolume  - destination D3D volume texture pSrcVolume  - input RenderMonkey volume texture See also: RmVolume Returns: True if successfully copied the texture, false otherwise (if any errors were encountered.

RMGFXUTIL_API bool RmGfxSetRmSurface (  RmSurface *  pDestSurface, IDirect3DSurface9 *  pSrcSurface, bool  bNeedToFlip )

Copies contents of D3D surface to a RenderMonkey texture surface. This method copies the contents of a texture surface from the input D3D texture surface into a RenderMonkey texture surface. After calling this function, the destination surface will have the same dimensions and pixel format as the input D3D texture surface Parameters: pDestVolume  - destination RenderMonkey texture surface See also: RmSurface Parameters: pSrcSurface  - input D3D texture surface Returns: True if successfully copied the texture, false otherwise (if any errors were encountered.

RMGFXUTIL_API bool RmGfxSetRmVolume (  RmVolume *  pDestVolume, IDirect3DVolume9 *  pSrcVolume, bool  bNeedToFlip )

Copies contents of a RenderMonkey volume texture to D3D volume. This method copies the contents of a volume texture from the input D3D texture into a RenderMonkey volume texture. Note that after this function is complete, the destination volume will be of the same size and pixel format as the input D3D volume texture Parameters: pDestVolume  - destination RenderMonkey volume texture See also: RmVolume Parameters: pSrcVolume  - input D3D volume texture Returns: True if successfully copied the texture, false otherwise (if any errors were encountered.

RMGFXUTIL_API D3DFORMAT RmGfxToD3DFormat (  RmPixelFormatType  format  )

Conversion from RenderMonkey pixel format into D3D format. Converts RenderMonkey pixel format value into D3D format value Parameters: format  RenderMonkey pixel format value See also: RmPixelFormatType Returns: Converted D3D pixel format value

---