updated comments

patch by Per Wigren <wigren@home.se>


git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@7896 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 20 insertions, 17 deletions

diff --git a/libmpcodecs/vf_bmovl.c b/libmpcodecs/vf_bmovl.c
index 30b7de65b1..24662fe1a3 100644
--- a/libmpcodecs/vf_bmovl.c
+++ b/libmpcodecs/vf_bmovl.c
@@ -6,22 +6,28 @@
  * Use MPlayer as a framebuffer to read bitmaps and commands from a FIFO
  * and display them in the window.
  *
- * FIXME: INSTRUCTION IS OUT OF DATE!!!
+ * Commands are:
  *
- * It understands the following format:
- * COMMAND width height xpos ypos alpha clear
+ * RGBA32 width height xpos ypos alpha clear
+ *   * Followed by width*height*4 bytes of raw RGBA32 data.
+ * ABGR32 width height xpos ypos alpha clear
+ *   * Followed by width*height*4 bytes of raw ABGR32 data.
+ * RGB24 width height xpos ypos alpha clear
+ *   * Followed by width*height*3 bytes of raw RGB32 data.
+ * BGR24 width height xpos ypos alpha clear
+ *   * Followed by width*height*3 bytes of raw BGR32 data.
  *
- * Commands are:
- * RGBA32    Followed by WIDTH*HEIGHT of raw RGBA32 data.
- * BGRA32    Followed by WIDTH*HEIGHT of raw BGRA32 data.
- * RGB24     Followed by WIDTH*HEIGHT of raw RGB24 data.
- * ALPHA     Set alpha for area. Values can be -255 to 255.
- *           0 = No change
- * CLEAR     Zero area
- * OPAQUE    Disable all alpha transparency!
- *           Send an ALPHA command with 0's to enable again!
- * HIDE      Hide bitmap
- * SHOW      Show bitmap
+ * ALPHA width height xpos ypos alpha
+ *   * Change alpha for area
+ * CLEAR width height xpos ypos
+ *   * Clear area
+ * OPAQUE
+ *   * Disable all alpha transparency!
+ *      Send "ALPHA 0 0 0 0 0" to enable again!
+ * HIDE
+ *   * Hide bitmap
+ * SHOW
+ *   * Show bitmap
  *
  * Arguments are:
  * width, height    Size of image/area
@@ -37,9 +43,6 @@
  *                  one, so you don't need to send 1,8MB of RGBA32 data
  *                  everytime a small part of the screen is updated.
  *
- * Note that you always have to send all arguments, even if they are not
- * used for a particular command!
- *
  * Arguments for the filter are hidden:opaque:fifo
  * For example 1:0:/tmp/myfifo.fifo will start the filter hidden, transparent
  * and use /tmp/myfifo.fifo as the fifo.