RmGfxUtil.h File Reference

#include <GfxUtil/RmGfxUtilTypes.h>

Go to the source code of this file.

Functions
RMGFXUTIL_API bool	RmGfxUtilD3DInitialize ()
RMGFXUTIL_API void	RmGfxUtilInit ()
RMGFXUTIL_API void	RmGfxUtilUninitialize ()
RMGFXUTIL_API bool	RmGfxBltSurface (RmSurface *pDestSurface, RmSurface *pSrcSurface, RmPixelFormatType destPixelFormat=RM_PIXELFORMAT_UNKNOWN, int destWidth=0, int destHeight=0, bool bAlphaOnly=false)
RMGFXUTIL_API bool	RmGfxFlipSurfaceY (RmSurface *pDestSurface, RmSurface *pSrcSurface)
RMGFXUTIL_API bool	RmGfxBltVolume (RmVolume *pDestVolume, RmVolume *pSrcVolume, RmPixelFormatType destPixelFormat=RM_PIXELFORMAT_UNKNOWN, int destWidth=0, int destHeight=0, int destDepth=0)
RMGFXUTIL_API bool	RmGfxFormatContainsAlpha (RmPixelFormatType pixelFormatType)
RMGFXUTIL_API HBITMAP	RmGfxCreateTextureBitmap (HDC hDC, RmTextureVariable *pRmTextureVariable, int nBitmapWidth, int nBitmapHeight, COLORREF rgbBackground, bool bAlphaOnly=false, int nMipMapLevel=0, int nVolumeDepth=-1)

---

Detailed Description

Graphics utilities

---

Function Documentation

RMGFXUTIL_API bool RmGfxBltSurface (  RmSurface *  pDestSurface, RmSurface *  pSrcSurface, RmPixelFormatType  destPixelFormat = RM_PIXELFORMAT_UNKNOWN, int  destWidth = 0, int  destHeight = 0, bool  bAlphaOnly = false )

Surface Conversion destPixelFormat specifies destination's format. If UNKNOWN, destination will have same format as source surface. destWidth/Height spcifies destination's size. If 0, source's width/height will be used. Parameters: pDestSurface  Destination surface See also: RmSurface Parameters: pSrcSurface  Source surface See also: RmSurface Parameters: destPixelFormat  Destinatyion pixelformat See also: RmPixelFormatType Parameters: destWidth  Destination width destHeight  Destination height bAlphaOnly  If true, only alpha channels are blitted Returns: True on success

RMGFXUTIL_API bool RmGfxBltVolume (  RmVolume *  pDestVolume, RmVolume *  pSrcVolume, RmPixelFormatType  destPixelFormat = RM_PIXELFORMAT_UNKNOWN, int  destWidth = 0, int  destHeight = 0, int  destDepth = 0 )

Volume Conversion destPixelFormat specifies destination's format. If UNKNOWN, destination will have same format as source surface. destWidth/Height/Depth spcifies destination's size. If 0, source's width/height/depth will be used. Parameters: pDestVolume  Destination volume See also: RmVolume Parameters: pSrcVolume  Source volume See also: RmVolume Parameters: destPixelFormat  Destinatyion pixelformat See also: RmPixelFormatType Parameters: destWidth  Destination width destHeight  Destination height destDepth  Destination depth Returns: True on success

RMGFXUTIL_API HBITMAP RmGfxCreateTextureBitmap (  HDC  hDC, RmTextureVariable *  pRmTextureVariable, int  nBitmapWidth, int  nBitmapHeight, COLORREF  rgbBackground, bool  bAlphaOnly = false, int  nMipMapLevel = 0, int  nVolumeDepth = -1 )

Helper functions for creating HBITMAPs from RmTextures Functions will return an HBITMAP compatible with the passed hDC. The bitmap will be resized to the passed width and height. Parameters: hDC  Window DC pRmTextureVariable  Texture variable See also: RmTextureVariable Parameters: nBitmapWidth  Width of bitmap nBitmapHeight  Height of bitmap rgbBackground  Background color bAlphaOnly  If true, only alpha channels are blitted Returns: Generated BITMAP handle

RMGFXUTIL_API bool RmGfxFlipSurfaceY (  RmSurface *  pDestSurface, RmSurface *  pSrcSurface )

Surface Flipping up-down DestSurafec will have image up side down from source Parameters: pDestSurface  Destination surface ( will have image flipped ) See also: RmSurface Parameters: pSrcSurface  Source surface See also: RmSurface Returns: True on success

RMGFXUTIL_API bool RmGfxFormatContainsAlpha (  RmPixelFormatType  pixelFormatType  )

Helper function to test whether the passed pixel format contains an alpha component or not Parameters: pixelFormatType  Pixelformat to test if it has alpha Returns: True if pixelformat does have alpha channel

RMGFXUTIL_API bool RmGfxUtilD3DInitialize (   )

Test for D3D availability Returns: Return if D3D is initialized correctly

RMGFXUTIL_API void RmGfxUtilInit (   )

Initialize Gfx utilities Returns: None

RMGFXUTIL_API void RmGfxUtilUninitialize (   )

Uninitialize Gfx utilities Returns: None

---