xenocara/lib/libdrm/mk/man/drmHandleEvent.3

81 lines
2.3 KiB
Groff

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "DRMHANDLEEVENT" 3 "September 2012" "" "Direct Rendering Manager"
.SH NAME
drmHandleEvent \- read and process pending DRM events
.SH SYNOPSIS
.sp
\fB#include <xf86drm.h>\fP
.sp
\fBint drmHandleEvent(int fd, drmEventContextPtr evctx);\fP
.SH DESCRIPTION
.sp
\fBdrmHandleEvent\fP processes outstanding DRM events on the DRM
file\-descriptor passed as \fBfd\fP\&. This function should be called after
the DRM file\-descriptor has polled readable; it will read the events and
use the passed\-in \fBevctx\fP structure to call function pointers with the
parameters noted below:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
typedef struct _drmEventContext {
int version;
void (*vblank_handler) (int fd,
unsigned int sequence,
unsigned int tv_sec,
unsigned int tv_usec,
void *user_data)
void (*page_flip_handler) (int fd,
unsigned int sequence,
unsigned int tv_sec,
unsigned int tv_usec,
void *user_data)
} drmEventContext, *drmEventContextPtr;
.ft P
.fi
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
\fBdrmHandleEvent\fP returns 0 on success, or if there is no data to
read from the file\-descriptor. Returns \-1 if the read on the
file\-descriptor fails or returns less than a full event record.
.SH REPORTING BUGS
.sp
Bugs in this function should be reported to
\fI\%https://gitlab.freedesktop.org/mesa/drm/\-/issues\fP
.SH SEE ALSO
.sp
\fBdrm\fP(7), \fBdrm\-kms\fP(7), \fBdrmModePageFlip\fP(3),
\fBdrmWaitVBlank\fP(3)
.\" Generated by docutils manpage writer.
.