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

Created FormatProperties (markdown)

Chuck Walbourn 2020-07-12 23:22:11 -07:00
parent 3f0763a017
commit 58aecfa92b

25
FormatProperties.md Normal file

@ -0,0 +1,25 @@
These functions return properties about known DXGI formats.
```cpp
bool HasAlpha(DXGI_FORMAT fmt);
```
```cpp
size_t BitsPerPixel(DXGI_FORMAT fmt);
```
```cpp
size_t BitsPerColorDXGI_FORMAT fmt);
```
```cpp
FORMAT_TYPE FormatDataType(DXGI_FORMAT fmt);
```
# Parameters
These functions all take a ``DXGI_FORMAT`` as their input value.
# Return value
The ``FormatDataType`` function returns ``FORMAT_TYPE_FLOAT``, ``FORMAT_TYPE_UNORM``, ``FORMAT_TYPE_SNORM``, ``FORMAT_TYPE_UINT``, ``FORMAT_TYPE_SINT`` or otherwise ``FORMAT_TYPE_TYPELESS``.