SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetPenName

Retrieves a human-readable description for a SDL_PenID.

Header File

Defined in <SDL3/SDL_pen.h>

Syntax

const char* SDL_GetPenName(SDL_PenID instance_id);

Function Parameters

SDL_PenID instance_id the pen to query.

Return Value

(const char *) Returns a string that contains the name of the pen, intended for human consumption. The string might or might not be localised, depending on platform settings. It is not guaranteed to be unique; use SDL_GetPenGUID() for (best-effort) unique identifiers. The pointer is managed by the SDL pen subsystem and must not be deallocated. The pointer remains valid until SDL is shut down. Returns NULL on error (cf. SDL_GetError()).

Remarks

The returned string follows the SDL_GetStringRule.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryPen


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.