D3DAPP.H
上传用户:bangxh
上传日期:2007-01-31
资源大小:42235k
文件大小:17k
源码类别:

Windows编程

开发平台:

Visual C++

  1. /*
  2.  *  Copyright (C) 1995, 1996 Microsoft Corporation. All Rights Reserved.
  3.  *
  4.  *  File: d3dapp.h
  5.  *
  6.  *  Header to be included in source using D3DApp.  Contains D3DApp function
  7.  *  prototypes and defines.
  8.  *
  9.  *  D3DApp is a collection of helper functions for Direct3D applications.
  10.  *  D3DApp consists of the following files:
  11.  * d3dapp.h    Main D3DApp header to be included by application
  12.  *      d3dappi.h   Internal header
  13.  *      d3dapp.c    D3DApp functions seen by application.
  14.  *      ddcalls.c   All calls to DirectDraw objects except textures
  15.  *      d3dcalls.c  All calls to Direct3D objects except textures
  16.  *      texture.c   Texture loading and managing texture list
  17.  *      misc.c     Miscellaneous calls
  18.  */
  19. #ifndef __D3DAPP_H__
  20. #define __D3DAPP_H__
  21. #define INITGUID
  22. #include <ddraw.h>
  23. #include <d3d.h>
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27. /*
  28.  * DEFINES
  29.  */
  30. #define D3DAPP_WINDOWMINIMUM 50     /* smallest buffer size allowed */
  31. #define D3DAPP_DEFAULTWINDOWDIM 320 /* replaces window size if invalid */
  32. #define D3DAPP_MINBUFFERSIZE 15360  /* minimum "maximum buffer size" for a
  33.        D3D driver to be accepted */
  34. #define D3DAPP_MINVERTEXCOUNT 320   /* minimum "maximum vertex count" for a
  35.        D3D driver to be accepted */
  36. #define D3DAPP_MAXD3DDRIVERS 5     /* maximum Direct3D drivers ever expected
  37.        to find */
  38. #define D3DAPP_MAXTEXTUREFORMATS 50 /* maximum texture formats */
  39. #define D3DAPP_MAXMODES 50     /* maximum display modes ever expected to
  40.        be reported by DirectDraw */
  41. #define D3DAPP_MAXTEXTURES 15     /* maximum number of textures that wil be
  42.        loaded and managed */
  43. #define D3DAPP_MAXCLEARRECTS 30     /* maximum num. rectangles (ie extents)
  44.        for clearing */
  45. #define D3DAPP_BOGUS -100     /* unused parameters accept this */
  46. #define D3DAPP_YOUDECIDE -25     /* Use this for certain parameters to
  47.        have D3DApp decide an appropriate
  48.        value for you */
  49. #define D3DAPP_USEWINDOW -24     /* Used in place of fullscreen mode */
  50. /*
  51.  * DATA STRUCTURES
  52.  */
  53. /*
  54.  * D3DAppD3DDriver structure
  55.  * Describes a D3D driver
  56.  */
  57. typedef struct tagD3DAppD3DDriver {
  58.     char Name[30]; /* short name of the driver */
  59.     char About[50]; /* short string about the driver */
  60.     D3DDEVICEDESC Desc; /* D3DDEVICEDESC for complete information */
  61.     GUID Guid; /* it's GUID */
  62.     BOOL bIsHardware; /* does this driver represent a hardware device? */
  63.     BOOL bDoesTextures; /* does this driver do texture mapping? */
  64.     BOOL bDoesZBuffer;  /* can this driver use a z-buffer? */
  65.     BOOL bCanDoWindow; /* can it render to Window's display depth? */
  66. } D3DAppD3DDriver;
  67. /*
  68.  * D3DAppTextureFormat stucture
  69.  * Describes a texture format
  70.  */
  71. typedef struct tagD3DAppTextureFormat {
  72.     DDSURFACEDESC ddsd; /* DDSURFACEDESC for complete information */
  73.     BOOL bPalettized; /* is this format palettized */
  74.     int RedBPP; /* number of red, */
  75.     int BlueBPP; /*                blue, */
  76.     int GreenBPP; /*                      and green bits per pixel */
  77.     int IndexBPP; /* number of bits in palette index */
  78. } D3DAppTextureFormat;
  79. /*
  80.  * D3DAppMode structure
  81.  * Describes a display mode
  82.  */
  83. typedef struct tagD3DAppMode {
  84.     int     w;       /* width */
  85.     int     h;       /* height */
  86.     int     bpp;       /* bits per pixel */
  87.     BOOL    bThisDriverCanDo; /*can current D3D driver render in this mode?*/
  88. } D3DAppMode;
  89. /*
  90.  * D3DAppInfo structure
  91.  * Contains all the information D3DApp makes available to the application. A
  92.  * pointer to the internal, read only copy is returned by the initializing
  93.  * function.
  94.  */
  95. typedef struct tagD3DAppInfo {
  96.     HWND     hwnd;    /*handle of window being managed*/
  97.     /*
  98.      * Direct3D objects and information
  99.      */
  100.     LPDIRECT3D2     lpD3D;    /* D3D object */
  101.     LPDIRECT3DDEVICE2     lpD3DDevice;   /* D3D device */
  102.     LPDIRECT3DVIEWPORT2     lpD3DViewport; /* D3D viewport, created by
  103.       application */
  104.     int     NumDrivers;    /* number of D3D drivers avail. */
  105.     int     CurrDriver;    /* number of curr. D3D driver */
  106.     D3DAppD3DDriver     Driver[D3DAPP_MAXD3DDRIVERS]; /* avail. drivers*/
  107.     D3DAppD3DDriver     ThisDriver;    /* description of this driver,
  108.    identical to Driver[CurrDriver] */
  109.     int     NumTextureFormats; /* num texture formats avail*/
  110.     int     CurrTextureFormat; /* current texture format
  111.   will only change if driver changes or when app changes it*/
  112.     D3DAppTextureFormat     TextureFormat[D3DAPP_MAXTEXTUREFORMATS];
  113.       /* description of all avail. formats */
  114.     D3DAppTextureFormat     ThisTextureFormat; /* description of this format,
  115.      identical to TextureFormat[CurrTextureFormat] */
  116.     int     NumTextures;    /* number of textures in D3DApp's
  117.        texture list */
  118.     char     ImageFile[D3DAPP_MAXTEXTURES][50]; /* files */
  119.     D3DTEXTUREHANDLE     TextureHandle[D3DAPP_MAXTEXTURES]; /* handles */
  120.     LPDIRECTDRAWSURFACE     lpTextureSurf[D3DAPP_MAXTEXTURES]; /* surfaces */
  121.     LPDIRECT3DTEXTURE2     lpTexture[D3DAPP_MAXTEXTURES]; /* texture objs */
  122.     int     NumUsableTextures; /* the number of currently usable
  123.   textures (e.g. for a hardware
  124.   device there may not be enough
  125.           video memory*/
  126.     /*
  127.      * DirectDraw objects and information
  128.      */
  129.     LPDIRECTDRAW     lpDD;    /* DirectDraw object */
  130.     BOOL     bIsPrimary;    /* Is this the primary DD device?
  131.        If FALSE, we're using a hardware DD device that cannot
  132.        display a window and so only fullscreen modes are available */
  133.     LPDIRECTDRAWSURFACE     lpFrontBuffer; /* front buffer surface */
  134.     LPDIRECTDRAWSURFACE     lpBackBuffer;  /* back buffer surface */
  135.     LPDIRECTDRAWSURFACE     lpZBuffer;     /* z-buffer surface */
  136.     BOOL     bBackBufferInVideo; /* back buf in video mem? */
  137.     BOOL     bZBufferInVideo; /* is Z-buf in video mem? */
  138.     int     NumModes; /* number of available display modes */
  139.     int     CurrMode; /* number of current display mode (only
  140.          when fullscreen) */
  141.     D3DAppMode     Mode[D3DAPP_MAXMODES]; /* desc avail modes */
  142.     D3DAppMode     ThisMode; /* description of this mode, identical
  143.  to Mode[CurrMode] */
  144.     BOOL     bFullscreen; /* in fullscreen exclusive mode? */
  145.     D3DAppMode     WindowsDisplay; /* current Windows disply mode */
  146.     SIZE     szClient;       /* dimensions of client win */
  147.     POINT     pClientOnPrimary; /* position of client win */
  148.     BOOL     bPaused;        /* the app is paused */
  149.     BOOL     bAppActive;        /* the app is active */
  150.     BOOL     bTexturesDisabled; /* textures are disabled */
  151.     BOOL     bOnlySystemMemory; /* all surfaces forced into
  152.   system memory */
  153.     BOOL     bOnlyEmulation;    /* no hardware DD or D3D
  154.   devices allowed */
  155.     BOOL     bMinimized;        /* app window is minimized */
  156.     BOOL     bRenderingIsOK;    /* All objects etc. necessary
  157.   for rendering are in ok */
  158. } D3DAppInfo;
  159. /*
  160.  * D3DAppRenderState structure
  161.  * The "render state" is the status of this collection of D3D options and
  162.  * variables.  This structure is used to get and set the render state.  The
  163.  * render state will only change during program initialization and when
  164.  * the application sets it.
  165.  */
  166. typedef struct tagD3DAppRenderState {
  167.     BOOL             bZBufferOn;    /* Z buffer is on */
  168.     BOOL             bPerspCorrect; /* perspective correction is on */
  169.     D3DSHADEMODE     ShadeMode;     /* flat, gouraud, phong? */
  170.     D3DTEXTUREFILTER TextureFilter; /* linear or bi-linear texture filter */
  171.     D3DTEXTUREBLEND  TextureBlend;  /* Use shade mode or copy mode? */
  172.     D3DFILLMODE      FillMode;     /* solid, lines or points? */
  173.     BOOL             bDithering;    /* dithering is on */
  174.     BOOL             bSpecular;     /* specular highlights are on */
  175.     BOOL             bAntialiasing; /* anti-aliasing is on */
  176.     BOOL      bFogEnabled;   /* fog is on */
  177.     D3DCOLOR      FogColor;     /* fog color */
  178.     D3DFOGMODE      FogMode;     /* linear, exp. etc. */
  179.     D3DVALUE      FogStart;     /* begining depth */
  180.     D3DVALUE      FogEnd;     /* ending depth */
  181. } D3DAppRenderState;
  182. /*
  183.  * FUNCTION PROTOTYPES
  184.  */
  185. /*
  186.  * D3DAppCreateFromHWND
  187.  *
  188.  * Call this before all other D3DApp functions (except AddTexture).  
  189.  * Initializes all DD and D3D objects necessary for rendering, enumerates the
  190.  * available display modes and drivers and loads textures specified by prior
  191.  * AddTexture() calls.  Caller passes the handle of the window to be manged
  192.  * and callback functions to execute for device creation and destruction.
  193.  * 
  194.  * DeviceCreateCallback is executed AFTER the creation of D3D device and all
  195.  * objects D3DApp created using the device.  This allows an application to
  196.  * reconstruct the scene and create any additional objects.  The callback
  197.  * must create and return (in the variable provided) the DIRECT3DVIEWPORT
  198.  * from the given width and height.  The returned pointer is stored in the
  199.  * D3DAppInfo structure and used for clearing and setting the render state.
  200.  * A NULL pointer is fine if D3DApp is not used for either of these
  201.  * functions. The create callback will always be called before any calls to
  202.  * the destroy callback.  The boolean returned indicates success or failure.
  203.  *
  204.  * DeviceDestroyCallback is executed BEFORE the D3D device and objects
  205.  * created by D3DApp using the device are released.  This allows an
  206.  * application to save data regarding the scene or release any objects
  207.  * created from the device before it is destroyed.  The DIRECT3DVIEWPORT
  208.  * should be released in this callback.  The boolean returned indicates the
  209.  * success or failure.
  210.  *
  211.  * A pointer to the internal D3DAppInfo data structure is returned.  This
  212.  * should be READ ONLY!
  213.  *
  214.  * The DirectDraw device, Direct3D driver, display mode and texture format
  215.  * will all be chosen by D3DApp.  Hardware DD and D3D devices are prefered.
  216.  * Mono lighting D3D drivers are prefered.  Paletted texture formats are
  217.  * prefered.  If possible, the current window size will be used, otherwise
  218.  * a fullscreen mode will be selected.
  219.  *
  220.  * Call AddTexture() to add textures to be loaded upon initialization.
  221.  *
  222.  * Valid flags:
  223.  *    D3DAPP_ONLYSYSTEMMEMORY  Force all surfaces into system memory.  Also
  224.  *                             disables hardware DD and D3D drivers.
  225.  *    D3DAPP_ONLYD3DEMULATION  Disable D3D hardware
  226.  *    D3DAPP_ONLYDDEMULATION   Disable DD hardware
  227.  */
  228. #define D3DAPP_ONLYSYSTEMMEMORY 0x00000001
  229. #define D3DAPP_ONLYD3DEMULATION 0x00000002
  230. #define D3DAPP_ONLYDDEMULATION 0x00000004
  231. BOOL D3DAppCreateFromHWND(DWORD flags, HWND hwnd,
  232.   BOOL(*DeviceCreateCallback)(int, int,
  233.       LPDIRECT3DVIEWPORT2*,
  234.       LPVOID),
  235.   LPVOID lpCreateContext,
  236.   BOOL(*DeviceDestroyCallback)(LPVOID),
  237.   LPVOID lpDestroyContext,
  238.   D3DAppInfo** D3DApp);
  239. /*
  240.  * D3DAppWindowProc
  241.  * To be truly effective, D3DApp should be allowed to trap incoming window
  242.  * messages such as WM_SIZE.  Call D3DAppWindowProc at the begining of the
  243.  * application's main window WindowProc with the message information.  If
  244.  * bStopProcessing is set to TRUE, stop processing the message and return
  245.  * lresult.
  246.  */
  247. BOOL D3DAppWindowProc(BOOL* bStopProcessing, LRESULT* lresult, HWND hwnd,
  248.       UINT message, WPARAM wParam, LPARAM lParam);
  249. /*
  250.  * D3DAppFullscreen
  251.  * Places the app in a fullscreen mode using the current driver.
  252.  */
  253. BOOL D3DAppFullscreen(int mode);
  254. /*
  255.  * D3DAppWindow
  256.  * Places the application in windowed mode at the given client size.  If w
  257.  * and h are D3DAPP_YOUDECIDE, D3DApp will decide on a suitable client size.
  258.  * If called while in fullscreen, restores the display mode and returns the
  259.  * hooked window to the size it was before a call to D3DAppFullscreen or to
  260.  * the size specified.
  261.  */
  262. BOOL D3DAppWindow(int w, int h);
  263. /*
  264.  * D3DAppChangeDriver 
  265.  * Changes the driver.  If the current display mode is incompatible with the
  266.  * driver, a new one will be selected and employed.  A new texture format is
  267.  * selected and textures are reloaded, hence their handles may change.  By
  268.  * default, paletted formats are prefered.
  269.  */
  270. BOOL D3DAppChangeDriver(int driver, DWORD flags);
  271. /*
  272.  * D3DAppAddTexture
  273.  * D3DApp has an internal list of textures which it maintains.  The image
  274.  * files will be reloaded when necessary and the texture handles, objects and
  275.  * surfaces will always be up to date and available in the D3DAppInfo
  276.  * structure.  D3DAppAddTextures adds the given PPM image file to this
  277.  * list.
  278.  *
  279.  * This is the only function which can be called before CreateD3DAppFromHWND.
  280.  * Use it to create a list of textures to load during this creation function.
  281.  *
  282.  * The handles and texture objects will change when the device or texture
  283.  * format changes.  To react to changes in the texture objects and surfaces,
  284.  * use the callback for D3D device creation/release and make necessary
  285.  * changes whenever calling D3DAppChangeTextureFormat.
  286.  *
  287.  * Image files are searched for in the current directory, D3DPATH env var, 
  288.  * and the "SoftwareMicrosoftDirect3D4.0D3D Path" registry entry.
  289.  *
  290.  */
  291. BOOL D3DAppAddTexture(const char* imagefile);
  292. /*
  293.  * D3DAppChangeTextureFormat
  294.  * Changes all textures to the given format.  Texture handles and objects
  295.  * will change.
  296.  */
  297. BOOL D3DAppChangeTextureFormat(int format);
  298. /*
  299.  * D3DAppDisableTextures
  300.  * Disables the textures by turning handles to NULL.  If the driver changes,
  301.  * textures are not loaded until this state is toggled by another call with a
  302.  * TRUE flag.
  303.  */
  304. BOOL D3DAppDisableTextures(BOOL flag);
  305. /*
  306.  * D3DAppSwapTextures
  307.  * Swaps first texture with the second, second with third, etc. while keeping
  308.  * the handles array the same.
  309.  */
  310. BOOL D3DAppSwapTextures(void);
  311. /*
  312.  * D3DAppSetRenderState
  313.  * Uses a D3D execute buffer to set the render state.  If lpState is NULL,
  314.  * the current settings are reset.
  315.  */
  316. BOOL D3DAppSetRenderState(D3DAppRenderState* lpState);
  317. /*
  318.  * D3DAppGetRenderState
  319.  * Returns the current render state.
  320.  */
  321. BOOL D3DAppGetRenderState(D3DAppRenderState* lpState);
  322. /*
  323.  * D3DAppShowBackBuffer
  324.  * Blts or flips the back buffer to the primary surface.  In the windowed
  325.  * case, only the dirty portion of the front buffer is blt'ed over.  The
  326.  * dirty region of front and back buffers is maintained by calls to
  327.  * D3DAppRenderExtents(). D3DAPP_SHOWALL will force the entire front buffer
  328.  * to be updated.
  329.  */
  330. #define D3DAPP_SHOWALL 0x00000001
  331. BOOL D3DAppShowBackBuffer(DWORD flags);
  332. /*
  333.  * D3DAppRenderExtents
  334.  * Tells D3DApp the extents of all regions updated on the back buffer as a
  335.  * list of D3DRECTs (no more than D3DAPP_MAXCLEARRECTS).  Call this before
  336.  * clearing the back buffer.  If the D3DAPP_CLEARALL flag is set, the extents
  337.  * are ignored and the entire back buffer is assumed to have changed.
  338.  */
  339. #define D3DAPP_CLEARALL 0x00000001
  340. BOOL D3DAppRenderExtents(DWORD dwCount, LPD3DRECT extent, DWORD flags);
  341. /*
  342.  * D3DAppClearBackBuffer
  343.  * Clears the back buffer and Z-buffer (if enabled).  D3DAPP_CLEARALL can be
  344.  * used to clear the entire back buffer.
  345.  */
  346. #define D3DAPP_CLEARALL 0x00000001
  347. BOOL D3DAppClearBackBuffer(DWORD flags);
  348. /*
  349.  * D3DAppCheckForLostSurfaces
  350.  * Checks all surfaces D3DApp has allocated and restores them if necessary.
  351.  * An error is returned on any type of failure, but it may be best to ignore
  352.  * it since restoring surface can fail for non-fatal reasons and the app may
  353.  * just want to spin.
  354.  */
  355. BOOL D3DAppCheckForLostSurfaces(void);
  356. /*
  357.  * D3DAppPause
  358.  * Use D3DAppPause(TRUE) to pause the app and D3DAppPause(FALSE) to unpause.
  359.  * When fullscreen, the menu bar is redrawn.  bPaused is updated to reflect
  360.  * the current status.
  361.  */
  362. BOOL D3DAppPause(BOOL flag);
  363. /*
  364.  * D3DAppErrorToString
  365.  * Converts a DirectDraw, Direct3D or Direct3D RM error code to a string.
  366.  */
  367. char* D3DAppErrorToString(HRESULT error);
  368. /*
  369.  * D3DAppCreateSurface
  370.  * Creates a surface described by ddsd.  Will force the surface into
  371.  * systemmemory if D3DApp was initialized with D3DAPP_ONLYSYSTEMMEMORY.
  372.  */
  373. BOOL D3DAppCreateSurface(DDSURFACEDESC *ddsd, LPDIRECTDRAWSURFACE *lplpSurf);
  374. /*
  375.  * D3DAppLastError
  376.  * D3DAppLastErrorString
  377.  * Returns the last D3DApp error as a string and HRESULT.
  378.  */
  379. HRESULT D3DAppLastError(void);
  380. char* D3DAppLastErrorString(void);
  381. /*
  382.  * D3DAppDestroy
  383.  * Destroys all objects including Direct Draw.  Call before program
  384.  * termination.
  385.  */
  386. BOOL D3DAppDestroy(void);
  387. #ifdef __cplusplus
  388. };
  389. #endif
  390. #endif // __D3DAPP_H__