1
0
mirror of https://github.com/microsoft/DirectXTex synced 2024-11-23 13:00:06 +00:00

Created GetWICCodec (markdown)

Chuck Walbourn 2015-06-21 09:54:12 -07:00
parent ba81d51d1d
commit ff00a41f7e

21
GetWICCodec.md Normal file

@ -0,0 +1,21 @@
Returns a WIC GUID for a given file container given a simple enumeration value. This function is optional and you can instead use the WIC container GUID directly instead.
REFGUID GetWICCodec( _In_ WICCodecs codec );
# Parameters
The _codecs_ enumeration is one of the following values:
* ``WIC_CODEC_BMP`` Windows Bitmap (``.bmp``)
* ``WIC_CODEC_JPEG`` Joint Photographic Experts Group (``.jpg``, ``.jpeg``)
* ``WIC_CODEC_PNG`` Portable Network Graphics (``.png``)
* ``WIC_CODEC_TIFF`` Tagged Image File Format (``.tif``, ``.tiff``)
* ``WIC_CODEC_GIF`` Graphics Interchange Format (``.gif``)
* ``WIC_CODEC_WMP`` Windows Media Photo / HD Photo / JPEG XR (``.hdp``, ``.jxr``, ``.wdp``).
* ``WIC_CODEC_ICO`` Windows Icon (``.ico``)
# Remarks
The primary benefit of this function is that you don't require including ``<wincodec.h>`` for every client module that calls DirectXTex's [[WIC I/O Functions]].
# Platform notes
Do not use ``WIC_CODEC_WMP`` for Xbox One XDK applications as the WMP / HD Photo WIC codec is not supported by that platform.