dx_error.c

The source code of Doom legacy for windows

// Emacs style mode select   -*- C++ -*- 
//-----------------------------------------------------------------------------
//
// $Id: dx_error.c,v 1.2 2000/02/27 00:42:12 hurdler Exp $
//
// Copyright (C) 1998-2000 by DooM Legacy Team.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
//
// $Log: dx_error.c,v $
// Revision 1.2  2000/02/27 00:42:12  hurdler
// fix CR+LF problem
//
// Revision 1.1.1.1  2000/02/22 20:32:33  hurdler
// Initial import into CVS (v1.29 pr3)
//
//
// DESCRIPTION:
//      DirectX error messages
//      adapted from DirectX6 sample code
//
//-----------------------------------------------------------------------------


#include <stdarg.h>

#include <ddraw.h>
#include <d3d.h>
#include <d3drmwin.h>
#include <d3drm.h>
#include <dsound.h>

#include "dx_error.h"

// -----------------
// DXErrorMessageBox
// Displays a message box containing the given formatted string.
// -----------------
/*
void __cdecl DXErrorMessageBox (HRESULT error) LPSTR fmt, ... )
{
    char buff[256];
    va_list args;
    
    va_start(args, fmt);
    wvsprintf(buff, fmt, args);
    va_end(args);
    
    lstrcat(buff, "\r\n");
    MessageBox( NULL, buff, "DirectX Error:", MB_ICONEXCLAMATION + MB_OK );
}*/


// ---------------
// DXErrorToString
// Returns a pointer to a string describing the given DD, D3D or D3DRM error code.
// ---------------
char* DXErrorToString (HRESULT error)
{
    switch(error) {
        case DD_OK:
            /* Also includes D3D_OK and D3DRM_OK */
            return "No error.";
        case DDERR_ALREADYINITIALIZED:
            return "This object is already initialized.";
        case DDERR_BLTFASTCANTCLIP:
            return "Return if a clipper object is attached to the source surface passed into a BltFast call.";
        case DDERR_CANNOTATTACHSURFACE:
            return "This surface can not be attached to the requested surface.";
        case DDERR_CANNOTDETACHSURFACE:
            return "This surface can not be detached from the requested surface.";
        case DDERR_CANTCREATEDC:
            return "Windows can not create any more DCs.";
        case DDERR_CANTDUPLICATE:
            return "Can't duplicate primary & 3D surfaces, or surfaces that are implicitly created.";
        case DDERR_CLIPPERISUSINGHWND:
            return "An attempt was made to set a cliplist for a clipper object that is already monitoring an hwnd.";
        case DDERR_COLORKEYNOTSET:
            return "No src color key specified for this operation.";
        case DDERR_CURRENTLYNOTAVAIL:
            return "Support is currently not available.";
        case DDERR_DIRECTDRAWALREADYCREATED:
            return "A DirectDraw object representing this driver has already been created for this process.";
        case DDERR_EXCEPTION:
            return "An exception was encountered while performing the requested operation.";
        case DDERR_EXCLUSIVEMODEALREADYSET:
            return "An attempt was made to set the cooperative level when it was already set to exclusive.";
        case DDERR_GENERIC:
            return "Generic failure.";
        case DDERR_HEIGHTALIGN:
            return "Height of rectangle provided is not a multiple of reqd alignment.";
        case DDERR_HWNDALREADYSET:
            return "The CooperativeLevel HWND has already been set. It can not be reset while the process has surfaces or palettes created.";
        case DDERR_HWNDSUBCLASSED:
            return "HWND used by DirectDraw CooperativeLevel has been subclassed, this prevents DirectDraw from restoring state.";
        case DDERR_IMPLICITLYCREATED:
            return "This surface can not be restored because it is an implicitly created surface.";
        case DDERR_INCOMPATIBLEPRIMARY:
            return "Unable to match primary surface creation request with existing primary surface.";
        case DDERR_INVALIDCAPS:
            return "One or more of the caps bits passed to the callback are incorrect.";
        case DDERR_INVALIDCLIPLIST:
            return "DirectDraw does not support the provided cliplist.";
        case DDERR_INVALIDDIRECTDRAWGUID:
            return "The GUID passed to DirectDrawCreate is not a valid DirectDraw driver identifier.";
        case DDERR_INVALIDMODE:
            return "DirectDraw does not support the requested mode.";
        case DDERR_INVALIDOBJECT:
            return "DirectDraw received a pointer that was an invalid DIRECTDRAW object.";
        case DDERR_INVALIDPARAMS:
            return "One or more of the parameters passed to the function are incorrect.";
        case DDERR_INVALIDPIXELFORMAT:
            return "The pixel format was invalid as specified.";
        case DDERR_INVALIDPOSITION:
            return "Returned when the position of the overlay on the destination is no longer legal for that destination.";
        case DDERR_INVALIDRECT:
            return "Rectangle provided was invalid.";
        case DDERR_LOCKEDSURFACES:
            return "Operation could not be carried out because one or more surfaces are locked.";
        case DDERR_NO3D:
            return "There is no 3D present.";
        case DDERR_NOALPHAHW:
            return "Operation could not be carried out because there is no alpha accleration hardware present or available.";
        case DDERR_NOBLTHW:
            return "No blitter hardware present.";
        case DDERR_NOCLIPLIST:
            return "No cliplist available.";
        case DDERR_NOCLIPPERATTACHED:
            return "No clipper object attached to surface object.";
        case DDERR_NOCOLORCONVHW:
            return "Operation could not be carried out because there is no color conversion hardware present or available.";
        case DDERR_NOCOLORKEY:
            return "Surface doesn't currently have a color key";
        case DDERR_NOCOLORKEYHW:
            return "Operation could not be carried out because there is no hardware support of the destination color key.";
        case DDERR_NOCOOPERATIVELEVELSET:
            return "Create function called without DirectDraw object method SetCooperativeLevel being called.";
        case DDERR_NODC:
            return "No DC was ever created for this surface.";
        case DDERR_NODDROPSHW:
            return "No DirectDraw ROP hardware.";
        case DDERR_NODIRECTDRAWHW:
            return "A hardware-only DirectDraw object creation was attempted but the driver did not support any hardware.";
        case DDERR_NOEMULATION:
            return "Software emulation not available.";
        case DDERR_NOEXCLUSIVEMODE:
            return "Operation requires the application to have exclusive mode but the application does not have exclusive mode.";
        case DDERR_NOFLIPHW:
            return "Flipping visible surfaces is not supported.";
        case DDERR_NOGDI:
            return "There is no GDI present.";
        case DDERR_NOHWND:
            return "Clipper notification requires an HWND or no HWND has previously been set as the CooperativeLevel HWND.";
        case DDERR_NOMIRRORHW:
            return "Operation could not be carried out because there is no hardware present or available.";
        case DDERR_NOOVERLAYDEST:
            return "Returned when GetOverlayPosition is called on an overlay that UpdateOverlay has never been called on to establish a destination.";
        case DDERR_NOOVERLAYHW:
            return "Operation could not be carried out because there is no overlay hardware present or available.";
        case DDERR_NOPALETTEATTACHED:
            return "No palette object attached to this surface.";
        case DDERR_NOPALETTEHW:
            return "No hardware support for 16 or 256 color palettes.";
        case DDERR_NORASTEROPHW:
            return "Operation could not be carried out because there is no appropriate raster op hardware present or available.";
        case DDERR_NOROTATIONHW:
            return "Operation could not be carried out because there is no rotation hardware present or available.";
        case DDERR_NOSTRETCHHW:
            return "Operation could not be carried out because there is no hardware support for stretching.";
        case DDERR_NOT4BITCOLOR:
            return "DirectDrawSurface is not in 4 bit color palette and the requested operation requires 4 bit color palette.";
        case DDERR_NOT4BITCOLORINDEX:
            return "DirectDrawSurface is not in 4 bit color index palette and the requested operation requires 4 bit color index palette.";
        case DDERR_NOT8BITCOLOR:
            return "DirectDrawSurface is not in 8 bit color mode and the requested operation requires 8 bit color.";
        case DDERR_NOTAOVERLAYSURFACE:
            return "Returned when an overlay member is called for a non-overlay surface.";
        case DDERR_NOTEXTUREHW: