Andrew Kesterson
549b27d3eb
Add file, structure, global, and function documentation across all libakgl-owned headers and sources, including parameter contracts and likely AKERR/AKGL_ERR exceptions. Add a strict Doxyfile and build the generated API documentation in Gitea CI with warnings treated as failures. Co-authored-by: Codex (GPT-5) <noreply@openai.com>
36 lines
1.3 KiB
C
36 lines
1.3 KiB
C
/**
|
|
* @file text.h
|
|
* @brief Declares the public text API.
|
|
*/
|
|
|
|
#ifndef _TEXT_H_
|
|
#define _TEXT_H_
|
|
|
|
#include <SDL3_ttf/SDL_ttf.h>
|
|
|
|
/**
|
|
* @brief Text loadfont.
|
|
* @param name Registry key or human-readable object name.
|
|
* @param filepath Path to the requested file.
|
|
* @param size Requested font size.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_KEY When the corresponding validation or operation fails.
|
|
* @throws AKERR_NULLPOINTER When the corresponding validation or operation fails.
|
|
* @throws AKGL_ERR_SDL When the corresponding validation or operation fails.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_text_loadfont(char *name, char *filepath, int size);
|
|
/**
|
|
* @brief Text rendertextat.
|
|
* @param font Font used to render the text.
|
|
* @param text UTF-8 text to render.
|
|
* @param color Text color.
|
|
* @param wraplength Maximum rendered line width; zero disables wrapping.
|
|
* @param x Horizontal destination coordinate.
|
|
* @param y Vertical destination coordinate.
|
|
* @return `NULL` on success, otherwise an error context owned by the caller.
|
|
* @throws AKERR_NULLPOINTER When the corresponding validation or operation fails.
|
|
*/
|
|
akerr_ErrorContext AKERR_NOIGNORE *akgl_text_rendertextat(TTF_Font *font, char *text, SDL_Color color, int wraplength, int x, int y);
|
|
|
|
#endif // _TEXT_H_
|