From 69c6b244a10283f717f9d6d7e3ba8b5a91889015 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Wed, 12 Aug 2020 19:59:43 +0200
Subject: client API: fix incorrect documentation in sw renderer

This was incorrect, and grossly misleading. It created the impression
that the buffer is passed to mpv_render_context_create(), instead of
mpv_render_context__render().
---
 libmpv/render.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/libmpv/render.h b/libmpv/render.h
index c25b2d2524..c9a6cec65e 100644
--- a/libmpv/render.h
+++ b/libmpv/render.h
@@ -349,7 +349,7 @@ typedef enum mpv_render_param_type {
     MPV_RENDER_PARAM_DRM_DISPLAY_V2 = 16,
     /**
      * MPV_RENDER_API_TYPE_SW only: rendering target surface size, mandatory.
-     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_create().
+     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render().
      * Type: int[2] (e.g.: int s[2] = {w, h}; param.data = &s[0];)
      *
      * The video frame is transformed as with other VOs. Typically, this means
@@ -360,7 +360,7 @@ typedef enum mpv_render_param_type {
     /**
      * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel format,
      * mandatory.
-     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_create().
+     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render().
      * Type: char* (e.g.: char *f = "rgb0"; param.data = f;)
      *
      * Valid values are:
@@ -383,7 +383,7 @@ typedef enum mpv_render_param_type {
     /**
      * MPV_RENDER_API_TYPE_SW only: rendering target surface bytes per line,
      * mandatory.
-     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_create().
+     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render().
      * Type: size_t*
      *
      * This is the number of bytes between a pixel (x, y) and (x, y + 1) on the
@@ -396,7 +396,7 @@ typedef enum mpv_render_param_type {
     /*
      * MPV_RENDER_API_TYPE_SW only: rendering target surface pixel data pointer,
      * mandatory.
-     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_create().
+     * Valid for MPV_RENDER_API_TYPE_SW & mpv_render_context_render().
      * Type: void*
      *
      * This points to the first pixel at the left/top corner (0, 0). In
-- 
cgit v1.2.3