summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2018-05-05 12:58:37 +0200
committerwm4 <wm4@nowhere>2018-05-24 19:56:33 +0200
commit95ab93d9f15f84271732bc785a72db846d2933dc (patch)
treec9f8d7d7352c85a5f3822e2d56189ae430a9fbcd
parent814869759c59ed3ce16604837fbf55e4f5ff7392 (diff)
downloadmpv-95ab93d9f15f84271732bc785a72db846d2933dc.tar.bz2
mpv-95ab93d9f15f84271732bc785a72db846d2933dc.tar.xz
client API: some doxygen fixes/additions
-rw-r--r--libmpv/client.h14
-rw-r--r--libmpv/render_gl.h18
-rw-r--r--libmpv/stream_cb.h2
3 files changed, 28 insertions, 6 deletions
diff --git a/libmpv/client.h b/libmpv/client.h
index 488ccb332c..d2a9ebfbac 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -195,6 +195,18 @@ extern "C" {
* or change the underlying datatypes. It might be a good idea to prefer
* MPV_FORMAT_STRING over other types to decouple your code from potential
* mpv changes.
+ *
+ * Future changes
+ * --------------
+ *
+ * This are the planned changes that will most likely be done on the next major
+ * bump of the library:
+ *
+ * - remove all symbols and include files that are marked as deprecated
+ * - reassign enum numerical values to remove gaps
+ * - remove the mpv_opengl_init_params.extra_exts field
+ * - change the type of mpv_event_end_file.reason
+ * - disabling all events by default
*/
/**
@@ -1575,6 +1587,7 @@ typedef struct mpv_event {
* MPV_EVENT_SET_PROPERTY_REPLY
* MPV_EVENT_COMMAND_REPLY
* MPV_EVENT_PROPERTY_CHANGE
+ * MPV_EVENT_HOOK
*/
uint64_t reply_userdata;
/**
@@ -1584,6 +1597,7 @@ typedef struct mpv_event {
* MPV_EVENT_LOG_MESSAGE: mpv_event_log_message*
* MPV_EVENT_CLIENT_MESSAGE: mpv_event_client_message*
* MPV_EVENT_END_FILE: mpv_event_end_file*
+ * MPV_EVENT_HOOK: mpv_event_hook*
* other: NULL
*
* Note: future enhancements might add new event structs for existing or new
diff --git a/libmpv/render_gl.h b/libmpv/render_gl.h
index 574be86ffd..44c445e427 100644
--- a/libmpv/render_gl.h
+++ b/libmpv/render_gl.h
@@ -107,11 +107,13 @@ typedef struct mpv_opengl_init_params {
/**
* This retrieves OpenGL function pointers, and will use them in subsequent
* operation.
- * Usually, GL context APIs do this for you (e.g. with glXGetProcAddressARB
- * or wglGetProcAddress), but some APIs do not always return pointers for
- * all standard functions (even if present); in this case you have to
- * compensate by looking up these functions yourself and returning them
- * from this callback.
+ * Usually, you can simply call the GL context APIs from this callback (e.g.
+ * glXGetProcAddressARB or wglGetProcAddress), but some APIs do not always
+ * return pointers for all standard functions (even if present); in this
+ * case you have to compensate by looking up these functions yourself when
+ * libmpv wants to resolve them through this callback.
+ * libmpv will not normally attempt to resolve GL functions on its own, nor
+ * does it link to GL libraries directly.
*/
void *(*get_proc_address)(void *ctx, const char *name);
/**
@@ -147,6 +149,9 @@ typedef struct mpv_opengl_fbo {
int internal_format;
} mpv_opengl_fbo;
+/**
+ * For MPV_RENDER_PARAM_DRM_DISPLAY.
+ */
typedef struct mpv_opengl_drm_params {
/**
* DRM fd (int). set this to -1 if invalid.
@@ -171,6 +176,9 @@ typedef struct mpv_opengl_drm_params {
struct _drmModeAtomicReq **atomic_request_ptr;
} mpv_opengl_drm_params;
+/**
+ * For MPV_RENDER_PARAM_DRM_OSD_SIZE.
+ */
typedef struct mpv_opengl_drm_osd_size {
/**
* size of the OSD in pixels.
diff --git a/libmpv/stream_cb.h b/libmpv/stream_cb.h
index 01de4700b2..5971aa2c32 100644
--- a/libmpv/stream_cb.h
+++ b/libmpv/stream_cb.h
@@ -112,7 +112,7 @@ typedef int64_t (*mpv_stream_cb_read_fn)(void *cookie, char *buf, uint64_t nbyte
* is used to test whether the stream is seekable (since seekability might
* depend on the URI contents, not just the protocol). Return
* MPV_ERROR_UNSUPPORTED if seeking is not implemented for this stream. This
- * seek also servies to establish the fact that streams start at position 0.
+ * seek also serves to establish the fact that streams start at position 0.
*
* This callback can be NULL, in which it behaves as if always returning
* MPV_ERROR_UNSUPPORTED.