DOXYGEN: Add doxy groups to remaining headers in 'graphics'

To make sure that they appear in the graphics group
in the doc structure.
This commit is contained in:
Bartosz Gentkowski 2020-11-29 02:55:02 +01:00 committed by Thierry Crozat
parent 22ea6375ed
commit a35cbeab46
16 changed files with 159 additions and 21 deletions

View file

@ -38,6 +38,14 @@ namespace Graphics {
class VectorRenderer; class VectorRenderer;
struct DrawStep; struct DrawStep;
/**
* @defgroup graphics_vector_renderer Vector renderer
* @ingroup graphics
*
* @brief VectorRenderer for drawing on a given surface.
*
* @{
*/
typedef void (VectorRenderer::*DrawingFunctionCallback)(const Common::Rect &, const Graphics::DrawStep &); typedef void (VectorRenderer::*DrawingFunctionCallback)(const Common::Rect &, const Graphics::DrawStep &);
@ -557,7 +565,7 @@ protected:
int _gradientFactor; /**< Multiplication factor of the active gradient */ int _gradientFactor; /**< Multiplication factor of the active gradient */
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -27,6 +27,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_vector_renderer_spec Specialized vector renderer
* @ingroup graphics
*
* @brief VectorRendererSpec class.
*
* @{
*/
/** /**
* VectorRendererSpec: Specialized Vector Renderer Class * VectorRendererSpec: Specialized Vector Renderer Class
* *
@ -379,6 +388,6 @@ protected:
int baseLeft = 0, int baseRight = 0); int baseLeft = 0, int baseRight = 0);
}; };
#endif #endif
/** @} */
} }
#endif #endif

View file

@ -27,6 +27,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_conversion Conversions
* @ingroup graphics
*
* @brief Graphics conversion operations.
*
* @{
*/
struct PixelFormat; struct PixelFormat;
/** Converting a color from YUV to RGB colorspace. */ /** Converting a color from YUV to RGB colorspace. */
@ -99,7 +108,7 @@ bool scaleBlitBilinear(byte *dst, const byte *src,
const uint dstW, const uint dstH, const uint dstW, const uint dstH,
const uint srcW, const uint srcH, const uint srcW, const uint srcH,
const Graphics::PixelFormat &fmt); const Graphics::PixelFormat &fmt);
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif // GRAPHICS_CONVERSION_H #endif // GRAPHICS_CONVERSION_H

View file

@ -27,6 +27,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_cursor Cursor
* @ingroup graphics
*
* @brief Cursor class used for representing the mouse cursor on the screen.
*
* @{
*/
/** /**
* A simple cursor representation * A simple cursor representation
* TODO: Switch to using Graphics::Surface instead of a byte* * TODO: Switch to using Graphics::Surface instead of a byte*
@ -57,7 +66,7 @@ public:
/** Return the number of colors in the palette. */ /** Return the number of colors in the palette. */
virtual uint16 getPaletteCount() const = 0; virtual uint16 getPaletteCount() const = 0;
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -32,6 +32,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_fontman Font manager
* @ingroup graphics
*
* @brief FontManager class used for managing fonts.
*
* @{
*/
class Font; class Font;
class BdfFont; class BdfFont;
@ -117,10 +126,14 @@ private:
Common::String _localizedFontName; Common::String _localizedFontName;
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
/** @addtogroup graphics_fontman
* @{
*/
/** Shortcut for accessing the font manager. */ /** Shortcut for accessing the font manager. */
#define FontMan (Graphics::FontManager::instance()) #define FontMan (Graphics::FontManager::instance())
/** @} */
#endif #endif

View file

@ -28,6 +28,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_fontman Korean font
* @ingroup graphics
*
* @brief FontKorean class used to handle Korean characters.
*
* @{
*/
/** /**
* A font that is able to draw Korean encoded characters. * A font that is able to draw Korean encoded characters.
*/ */
@ -219,7 +228,7 @@ private:
bool englishLoadData(const char *fontFile); bool englishLoadData(const char *fontFile);
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -21,11 +21,17 @@
*/ */
/** /**
* @file * @defgroup graphics_maccursor Mac cursor
* Macintosh cursor decoding used in engines: * @ingroup graphics
*
* @brief Macintosh cursor decoding.
*
* Used in engines:
* - mohawk * - mohawk
* - sci * - sci
* - scumm * - scumm
*
* @{
*/ */
#ifndef GRAPHICS_MACCURSOR_H #ifndef GRAPHICS_MACCURSOR_H
@ -78,7 +84,7 @@ protected:
/** Clear the cursor. */ /** Clear the cursor. */
void clear(); void clear();
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -26,6 +26,15 @@
#include "common/scummsys.h" #include "common/scummsys.h"
#include "common/noncopyable.h" #include "common/noncopyable.h"
/**
* @defgroup graphics_palette PaletteManager
* @ingroup graphics
*
* @brief The PaletteManager class.
*
* @{
*/
/** /**
* The PaletteManager is part of the OSystem backend API and responsible * The PaletteManager is part of the OSystem backend API and responsible
* for handling the (possibly emulated) "hardware" palette needed for * for handling the (possibly emulated) "hardware" palette needed for
@ -98,5 +107,5 @@ public:
*/ */
virtual void grabPalette(byte *colors, uint start, uint num) const = 0; virtual void grabPalette(byte *colors, uint start, uint num) const = 0;
}; };
/** @} */
#endif #endif

View file

@ -32,6 +32,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_pixelbuffer Pixel buffers
* @ingroup graphics
*
* @brief Class for managing pixel buffers.
*
* @{
*/
class PixelBuffer { class PixelBuffer {
public: public:
/** /**
@ -269,5 +278,5 @@ private:
}; };
} }
/** @} */
#endif #endif

View file

@ -28,6 +28,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_renderer Renderer
* @ingroup graphics
*
* @brief API for managing renderer engines.
*
* @{
*/
/** /**
* List of renderer types * List of renderer types
* *
@ -56,7 +65,7 @@ Common::String getRendererTypeCode(RendererType type);
/** Get the best matching renderer among available renderers */ /** Get the best matching renderer among available renderers */
RendererType getBestMatchingAvailableRendererType(RendererType desired); RendererType getBestMatchingAvailableRendererType(RendererType desired);
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -30,6 +30,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_screen Screen
* @ingroup graphics
*
* @brief Screen class for managing the screen.
*
* @{
*/
#define PALETTE_COUNT 256 #define PALETTE_COUNT 256
#define PALETTE_SIZE (256 * 3) #define PALETTE_SIZE (256 * 3)
@ -117,7 +126,7 @@ public:
*/ */
void clearPalette(); void clearPalette();
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -48,6 +48,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_sjis Shift JIS font
* @ingroup graphics
*
* @brief FontSJIS class for handling Japanese characters.
*
* @{
*/
struct Surface; struct Surface;
/** /**
@ -285,7 +294,7 @@ private:
}; };
// TODO: Consider adding support for PC98 ROM // TODO: Consider adding support for PC98 ROM
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -32,6 +32,15 @@ class WriteStream;
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_thumbnail Thumbnails
* @ingroup graphics
*
* @brief API for managing screen thumbnails used for save games.
*
* @{
*/
struct Surface; struct Surface;
/** /**
@ -82,7 +91,7 @@ bool createScreenShot(Graphics::Surface &surf);
*/ */
Graphics::Surface *scale(const Graphics::Surface &srcImage, int xSize, int ySize); Graphics::Surface *scale(const Graphics::Surface &srcImage, int xSize, int ySize);
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -45,6 +45,15 @@
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_transparent_surface Transparent surface
* @ingroup graphics
*
* @brief TransparentSurface class.
*
* @{
*/
// Enums // Enums
/** /**
@brief The possible flipping parameters for the blit method. @brief The possible flipping parameters for the blit method.
@ -185,7 +194,7 @@ private:
delete ptr; delete ptr;
} }
};*/ };*/
/** @} */
} // End of namespace Graphics } // End of namespace Graphics

View file

@ -34,6 +34,15 @@ class SeekableReadStream;
namespace Graphics { namespace Graphics {
/**
* @defgroup graphics_wincursor Windows cursor
* @ingroup graphics
*
* @brief API related to Windows cursors.
*
* @{
*/
/** /**
* A structure holding an array of cursors from a single Windows Executable cursor group. * A structure holding an array of cursors from a single Windows Executable cursor group.
* *
@ -64,7 +73,7 @@ struct WinCursorGroup {
* @note The calling code is responsible for deleting the returned pointer. * @note The calling code is responsible for deleting the returned pointer.
*/ */
Cursor *makeDefaultWinCursor(); Cursor *makeDefaultWinCursor();
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#endif #endif

View file

@ -21,8 +21,10 @@
*/ */
/** /**
* @file * @defgroup graphics_yuvtorgb YUV to RGB conversion
* YUV to RGB conversion. * @ingroup graphics
*
* @brief Methods for converting YUV images into RGB surfaces.
* *
* Used in video: * Used in video:
* - BinkDecoder * - BinkDecoder
@ -30,6 +32,7 @@
* - PSXStreamDecoder * - PSXStreamDecoder
* - TheoraDecoder * - TheoraDecoder
* - SVQ1Decoder * - SVQ1Decoder
* @{
*/ */
#ifndef GRAPHICS_YUV_TO_RGB_H #ifndef GRAPHICS_YUV_TO_RGB_H
@ -129,7 +132,7 @@ private:
int16 _colorTab[4 * 256]; // 2048 bytes int16 _colorTab[4 * 256]; // 2048 bytes
bool _alphaMode; bool _alphaMode;
}; };
/** @} */
} // End of namespace Graphics } // End of namespace Graphics
#define YUVToRGBMan (::Graphics::YUVToRGBManager::instance()) #define YUVToRGBMan (::Graphics::YUVToRGBManager::instance())