Improved documentation for SDL_Surface fields

This commit is contained in:
Sam Lantinga 2024-09-30 19:27:39 -07:00
parent 13c5d1092f
commit e3dbd74fe7

View File

@ -108,11 +108,12 @@ typedef struct SDL_SurfaceData SDL_SurfaceData;
*/
typedef struct SDL_Surface
{
SDL_SurfaceFlags flags; /**< Read-only */
SDL_PixelFormat format; /**< Read-only */
int w, h; /**< Read-only */
int pitch; /**< Read-only */
void *pixels; /**< Read-only pointer, writable pixels if non-NULL */
SDL_SurfaceFlags flags; /**< The flags of the surface, read-only */
SDL_PixelFormat format; /**< The format of the surface, read-only */
int w; /**< The width of the surface, read-only. */
int h; /**< The height of the surface, read-only. */
int pitch; /**< The distance in bytes between rows of pixels, read-only */
void *pixels; /**< A pointer to the pixels of the surface, the pixels are writeable if non-NULL */
int refcount; /**< Application reference count, used when freeing surface */