From fcd0734a9c195b5bf0e3586ccb7bb5a0365e3f88 Mon Sep 17 00:00:00 2001 From: Giovanni Bajo Date: Tue, 12 Nov 2024 16:31:55 +0100 Subject: [PATCH] Docs --- include/display.h | 7 ++++--- include/rdpq_tex.h | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/include/display.h b/include/display.h index 4781849d4..220cb1c2a 100644 --- a/include/display.h +++ b/include/display.h @@ -296,11 +296,12 @@ uint32_t display_get_bitdepth(void); uint32_t display_get_num_buffers(void); /** - * @brief Get the current refreshed rate of the TV in Hz + * @brief Get the current refresh rate of the video output in Hz * * The refresh rate is normally 50 for PAL and 60 for NTSC, but this function - * will also account for advanced VI configurations affecting the refresh rate, - * like PAL60. + * returns the hardware-accurate number which is close to those but not quite + * exact. Moreover, this will also account for advanced VI configurations + * affecting the refresh rate, like PAL60. * * @return float Refresh rate in Hz (frames per second) */ diff --git a/include/rdpq_tex.h b/include/rdpq_tex.h index f3d2f9050..90179d25f 100644 --- a/include/rdpq_tex.h +++ b/include/rdpq_tex.h @@ -42,7 +42,7 @@ typedef struct rdpq_texparms_s { struct { float translate; ///< Translation of the texture (in pixels) - int scale_log; ///< Power of 2 scale modifier of the texture (default: 0). Eg: -2 = make the texture 4 times smaller + int scale_log; ///< Power of 2 scale modifier of the texture (default: 0). Eg: -2 = make the texture 4 times smaller. Range is [-5..10] float repeats; ///< Number of repetitions before the texture clamps (default: 1). Use #REPEAT_INFINITE for infinite repetitions (wrapping) bool mirror; ///< Repetition mode (default: MIRROR_NONE). If true (MIRROR_REPEAT), the texture mirrors at each repetition