Final Platform Layer 0.9.8-beta
Loading...
Searching...
No Matches
Functions
Clipboard functions

This category contains functions for reading/writing clipboard data. More...

Functions

fpl_platform_api bool fplGetClipboardText (char *dest, const uint32_t maxDestLen)
 Retrieves the current clipboard text.
 
fpl_platform_api bool fplSetClipboardText (const char *text)
 Overwrites the current clipboard text with the given one.
 

Detailed Description

This category contains functions for reading/writing clipboard data.

Function Documentation

◆ fplGetClipboardText()

fpl_platform_api bool fplGetClipboardText ( char *  dest,
const uint32_t  maxDestLen 
)

Retrieves the current clipboard text.

Parameters
destThe destination string buffer to write the clipboard text into.
maxDestLenThe total number of characters available in the destination buffer.
Returns
Returns true when the clipboard contained text which is copied into the dest buffer, fpl_null otherwise.

◆ fplSetClipboardText()

fpl_platform_api bool fplSetClipboardText ( const char *  text)

Overwrites the current clipboard text with the given one.

Parameters
textThe new clipboard string.
Returns
Returns true when the text in the clipboard was changed, false otherwise.