Commit 384bdace authored by Luca Barbato's avatar Luca Barbato

doxy: cleanup pixfmt.h

Remove the dubious warning about the header being private and
add some formatting
parent 3fe5fc93
...@@ -25,21 +25,21 @@ ...@@ -25,21 +25,21 @@
* @file * @file
* pixel format definitions * pixel format definitions
* *
* @warning This file has to be considered an internal but installed
* header, so it should not be directly included in your projects.
*/ */
#include "libavutil/avconfig.h" #include "libavutil/avconfig.h"
/** /**
* Pixel format. Notes: * Pixel format.
* *
* @note
* PIX_FMT_RGB32 is handled in an endian-specific manner. An RGBA * PIX_FMT_RGB32 is handled in an endian-specific manner. An RGBA
* color is put together as: * color is put together as:
* (A << 24) | (R << 16) | (G << 8) | B * (A << 24) | (R << 16) | (G << 8) | B
* This is stored as BGRA on little-endian CPU architectures and ARGB on * This is stored as BGRA on little-endian CPU architectures and ARGB on
* big-endian CPUs. * big-endian CPUs.
* *
* @par
* When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
* image data is stored in AVFrame.data[0]. The palette is transported in * image data is stored in AVFrame.data[0]. The palette is transported in
* AVFrame.data[1], is 1024 bytes long (256 4-byte entries) and is * AVFrame.data[1], is 1024 bytes long (256 4-byte entries) and is
...@@ -49,11 +49,13 @@ ...@@ -49,11 +49,13 @@
* This is important as many custom PAL8 video codecs that were designed * This is important as many custom PAL8 video codecs that were designed
* to run on the IBM VGA graphics adapter use 6-bit palette components. * to run on the IBM VGA graphics adapter use 6-bit palette components.
* *
* @par
* For all the 8bit per pixel formats, an RGB32 palette is in data[1] like * For all the 8bit per pixel formats, an RGB32 palette is in data[1] like
* for pal8. This palette is filled in automatically by the function * for pal8. This palette is filled in automatically by the function
* allocating the picture. * allocating the picture.
* *
* Note, make sure that all newly added big endian formats have pix_fmt&1==1 * @note
* make sure that all newly added big endian formats have pix_fmt&1==1
* and that all newly added little endian formats have pix_fmt&1==0 * and that all newly added little endian formats have pix_fmt&1==0
* this allows simpler detection of big vs little endian. * this allows simpler detection of big vs little endian.
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment