Files
itgmania212121/src/RageTextureID.h
T
2011-03-17 01:47:30 -04:00

100 lines
3.9 KiB
C

/* RageTextureID - An identifier for a texture and associated loading parameters. */
#ifndef RAGE_TEXTURE_ID_H
#define RAGE_TEXTURE_ID_H
/* A unique texture is identified by a RageTextureID. (Loading the
* same file with two different dither settings is considered two
* different textures, for example.) See RageTexture.cpp for explanations
* of these. */
struct RageTextureID
{
RString filename;
// Maximum size of the texture, per dimension.
int iMaxSize;
// Generate mipmaps for this texture
bool bMipMaps;
/* Maximum number of bits for alpha. In 16-bit modes, lowering
* this gives more bits for color values. (0, 1 or 4) */
int iAlphaBits;
/* If this is greater than -1, then the image will be loaded as a luma/alpha
* map, eg. I4A4. At most 8 bits per pixel will be used This only actually happens
* when paletted textures are supported.
*
* If the sum of alpha and grayscale bits is <= 4, and the system supports 4-bit
* palettes, then the image will be loaded with 4bpp.
*
* This may be set to 0, resulting in an alpha map with all pixels white. */
int iGrayscaleBits;
/* Preferred color depth of the image. (This is overridden for
* paletted images and transparencies.) -1 for default. */
int iColorDepth;
// If true and color precision is being lost, dither. (slow)
bool bDither;
// If true, resize the image to fill the internal texture. (slow)
bool bStretch;
/* If true, enable HOT PINK color keying. (deprecated but needed for
* banners) */
bool bHotPinkColorKey; // #FF00FF
// These hints will be used in addition to any in the filename.
RString AdditionalTextureHints;
bool operator< (const RageTextureID &rhs) const;
bool operator== (const RageTextureID &rhs) const;
/* Used by RageTextureManager. Order is important; see RageTextureManager.cpp.
* Note that this property is not considered for ordering/equality. Loading
* a texture with a different loading policy will reuse the same texture with
* a different policy. */
enum TexPolicy { TEX_VOLATILE, TEX_DEFAULT } Policy;
void Init();
RageTextureID(): filename(RString()), iMaxSize(0), bMipMaps(false),
iAlphaBits(0), iGrayscaleBits(0), iColorDepth(0),
bDither(false), bStretch(false), bHotPinkColorKey(false),
AdditionalTextureHints(RString()), Policy(TEX_DEFAULT) { Init(); }
RageTextureID( const RString &fn ): filename(RString()), iMaxSize(0),
bMipMaps(false), iAlphaBits(0), iGrayscaleBits(0),
iColorDepth(0), bDither(false), bStretch(false),
bHotPinkColorKey(false), AdditionalTextureHints(RString()),
Policy(TEX_DEFAULT) { Init(); SetFilename(fn); }
void SetFilename( const RString &fn );
};
#endif
/*
* Copyright (c) 2003-2004 Chris Danford, Glenn Maynard
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, and/or sell copies of the Software, and to permit persons to
* whom the Software is furnished to do so, provided that the above
* copyright notice(s) and this permission notice appear in all copies of
* the Software and that both the above copyright notice(s) and this
* permission notice appear in supporting documentation.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/