fdo-mirrors/xorg-libxcursor
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/lib/libxcursor.git synced 2026-05-08 10:08:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

document the cursor-comments functions

Browse source 
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
This commit is contained in:
Thomas E. Dickey 2021-03-16 19:34:51 -04:00
parent 821254578e
commit bacd41c0c0
No known key found for this signature in database
GPG key ID: 702353E0F7E48EDB
6 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
man/Makefile.am
View file

@ -8,6 +8,10 @@ Xcursor_shadows = \
XcursorAnimateCreate \
XcursorAnimateDestroy \
XcursorAnimateNext \
XcursorCommentCreate \
XcursorCommentDestroy \
XcursorCommentsCreate \
XcursorCommentsDestroy \
XcursorCursorsCreate \
XcursorCursorsDestroy \
XcursorFileLoad \

33
man/Xcursor.man
View file

@ -546,6 +546,39 @@ XcursorCursors *XcursorShapeLoadCursors (
.NE
These map \fIshape\fP to a library name and then load the cursors.
.
.SS X Cursor Comment APIs
.NS
XcursorComment *XcursorCommentCreate (
XcursorUInt comment_type,
int length)
.NE
XcursorXcFileLoad uses this function to allocate an XcursorComment
structure for a single cursor.
The \fIcomment_type\fP parameter is used as the \fIsubtype\fP field,
e.g., COPYRIGHT.
The \fIlength\fP is the number of bytes to allocate for the comment text.
.
.NS
void XcursorCommentDestroy(
XcursorComment *comment)
.NE
Deallocates the given XcursorComment structure.
.
.NS
XcursorComments * XcursorCommentsCreate (
int size)
.NE
XcursorXcFileLoad uses this function to allocate an index of
XcursorComment structure pointers.
The \fIsize\fP parameter tells it how many pointers will be in the index.
.
.NS
void XcursorCommentsDestroy (
XcursorComments *comments)
.NE
Deallocates the given XcursorComments structure
as well as the XcursorComment structures which it points to.
.
.SS Animated Cursors
.NS
XcursorAnimate * XcursorAnimateCreate (

1
man/XcursorCommentCreate.man Normal file
View file

@ -0,0 +1 @@
.so man__libmansuffix__/Xcursor.__libmansuffix__

1
man/XcursorCommentDestroy.man Normal file
View file

@ -0,0 +1 @@
.so man__libmansuffix__/Xcursor.__libmansuffix__

1
man/XcursorCommentsCreate.man Normal file
View file

@ -0,0 +1 @@
.so man__libmansuffix__/Xcursor.__libmansuffix__

1
man/XcursorCommentsDestroy.man Normal file
View file

@ -0,0 +1 @@
.so man__libmansuffix__/Xcursor.__libmansuffix__