gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source 
[ci skip]
This commit is contained in:
SDL Wiki Bot
2024-12-16 06:13:48 +00:00
parent 79316ca36e
commit 3fa0537565
10 changed files with 54 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
include/SDL3/SDL_clipboard.h
View File

@@ -29,19 +29,18 @@
*
* ## Basic use (text)
*
* Obtaining and publishing simple text to the system clipboard is as easy
* as calling SDL_GetClipboardText() and SDL_SetClipboardText(),
* respectively. These deal with C strings in UTF-8 encoding. Data
* transmission and encoding conversion is completely managed by SDL.
* Obtaining and publishing simple text to the system clipboard is as easy as
* calling SDL_GetClipboardText() and SDL_SetClipboardText(), respectively.
* These deal with C strings in UTF-8 encoding. Data transmission and encoding
* conversion is completely managed by SDL.
*
* ## Clipboard callbacks (data other than text)
*
* Things get more complicated when the clipboard contains something other
* than text. Not only can the system clipboard contain data of any type,
* in some cases it can contain the same data in different formats! For
* example, an image painting app might let the user copy a graphic to the
* clipboard, and offers it in .BMP, .JPG, or .PNG format for other apps to
* consume.
* than text. Not only can the system clipboard contain data of any type, in
* some cases it can contain the same data in different formats! For example,
* an image painting app might let the user copy a graphic to the clipboard,
* and offers it in .BMP, .JPG, or .PNG format for other apps to consume.
*
* Obtaining clipboard data ("pasting") like this is a matter of calling
* SDL_GetClipboardData() and telling it the mimetype of the data you want.
@@ -56,9 +55,9 @@
* rather the mimetypes it is willing to provide and a callback function.
* During the callback, the app will generate the data. This allows massive
* data sets to be provided to the clipboard, without any data being copied
* before it is explicitly requested. More specifically, it allows an app
* to offer data in multiple formats without providing a copy of all of
* them upfront. If the app has an image that it could provide in PNG or JPG
* before it is explicitly requested. More specifically, it allows an app to
* offer data in multiple formats without providing a copy of all of them
* upfront. If the app has an image that it could provide in PNG or JPG
* format, it doesn't have to encode it to either of those unless and until
* something tries to paste it.
*
@@ -67,11 +66,11 @@
* The X11 and Wayland video targets have a concept of the "primary selection"
* in addition to the usual clipboard. This is generally highlighted (but not
* explicitly copied) text from various apps. SDL offers APIs for this through
* SDL_GetPrimarySelectionText() and SDL_SetPrimarySelectionText().
* SDL offers these APIs on platforms without this concept, too, but only so
* far that it will keep a copy of a string that the app sets for later
* retrieval; the operating system will not ever attempt to change the
* string externally if it doesn't support a primary selection.
* SDL_GetPrimarySelectionText() and SDL_SetPrimarySelectionText(). SDL offers
* these APIs on platforms without this concept, too, but only so far that it
* will keep a copy of a string that the app sets for later retrieval; the
* operating system will not ever attempt to change the string externally if
* it doesn't support a primary selection.
*/
#ifndef SDL_clipboard_h_