FORMAT_TYPE enumeration
The FORMAT_TYPE enumeration describes the format of a buffer and how it should be treated.
Syntax
typedef enum eFORMAT_TYPE {
FORMAT_VIDEO_TYPE_SYSTEMMEM = 0x001,
FORMAT_VIDEO_TYPE_VIDEOMEM = 0x002,
FORMAT_VIDEO_TYPE_SYSTEM_OR_VIDEO_MEM = 0x004,
FORMAT_VIDEO_TYPE_ALPHA = 0x010,
FORMAT_VIDEO_TYPE_NONALPHA = 0x020,
FORMAT_VIDEO_FLAG_FORCELETTERBOX = 0x100,
FORMAT_VIDEO_FLAG_CANLETTERBOX = 0x200,
FORMAT_AUDIO_TYPE_BUFFER = 0x001,
FORMAT_FLAG_READONLY = 0x010000,
FORMAT_FLAG_INPLACE_RENDER = 0x020000,
FORMAT_FLAG_PREROLL = 0x100000,
FORMAT_FLAG_MASK = 0xFFFF0000,
FORMAT_VIDEO_LOCATION_TYPE_MASK = 0x0F,
FORMAT_VIDEO_COLOR_TYPE_MASK = 0xF0,
FORMAT_MEDIA_TYPE_MASK = 0xFFFF
} FORMAT_TYPE;
Constants
-
FORMAT_VIDEO_TYPE_SYSTEMMEM
-
The buffer uses system memory. Specifying this can reduce performance.
-
FORMAT_VIDEO_TYPE_VIDEOMEM
-
The buffer uses video memory. Specifying this can improve performance.
-
FORMAT_VIDEO_TYPE_SYSTEM_OR_VIDEO_MEM
-
The buffer can use system or video memory.
-
FORMAT_VIDEO_TYPE_ALPHA
-
The buffer contains alpha blending data.
-
FORMAT_VIDEO_TYPE_NONALPHA
-
The buffer does not contain alpha blending data.
-
FORMAT_VIDEO_FLAG_FORCELETTERBOX
-
The video information is in letterbox format only.
-
FORMAT_VIDEO_FLAG_CANLETTERBOX
-
The video information can be displayed in letterbox format.
-
FORMAT_AUDIO_TYPE_BUFFER
-
This is an audio buffer. The value is the same as FORMAT_VIDEO_TYPE_SYSTEMMEM because all audio uses system memory.
-
FORMAT_FLAG_READONLY
-
The data should not be modified inside this buffer; you should create a new buffer to hold modified data. Contrast with FORMAT_FLAG_INPLACE_RENDER.
-
FORMAT_FLAG_INPLACE_RENDER
-
The data should be modified in place, in the buffer. Contrast with FORMAT_FLAG_READONLY.
-
FORMAT_FLAG_PREROLL
-
This buffer should be prerolled.
-
FORMAT_FLAG_MASK
-
A mask to determine the upper two bytes of the enumeration value.
-
FORMAT_VIDEO_LOCATION_TYPE_MASK
-
A mask to determine what kind of memory this buffer uses system memory (FORMAT_VIDEO_TYPE_SYSTEMMEM) or video memory (FORMAT_VIDEO_TYPE_VIDEOMEM).
-
FORMAT_VIDEO_COLOR_TYPE_MASK
-
A mask to determine whether the enumeration value contains alpha blending data. See FORMAT_VIDEO_TYPE_ALPHA and FORMAT_VIDEO_TYPE_NONALPHA.
-
FORMAT_MEDIA_TYPE_MASK
-
A mask to determine the lower two bytes of the enumeration value. (This includes the basic media type of the buffer.)
Requirements
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Header |
|