-
Notifications
You must be signed in to change notification settings - Fork 437
TransformImage
DirectXTex |
---|
Creates a new image by executing a user-supplied function across an input image.
HRESULT TransformImage(
const Image& image,
std::function<
void(XMVECTOR* outPixels, const XMVECTOR* inPixels, size_t width, size_t y)
> pixelFunc,
ScratchImage& result );
HRESULT TransformImage(
const Image* srcImages, size_t nimages, const TexMetadata& metadata,
std::function<
void(XMVECTOR* outPixels, const XMVECTOR* inPixels, size_t width, size_t y)
> pixelFunc,
ScratchImage& result );
Breaking change notice: In the September 2016 release this function was
Transform
but this generic name can cause conflicts in some client code so it was renamedTransformImage
.
pixelFunc: A callback function to invoke for each scanline of the image which outputs the new scanline.
This function performs a colorkey or chromakey transformation setting alpha to 0 (transparent) wherever the color is found and 1 (opaque) otherwise.
ScratchImage result;
hr = TransformImage(image->GetImages(), image->GetImageCount(), image->GetMetadata(),
[](XMVECTOR* outPixels, const XMVECTOR* inPixels, size_t width, size_t y)
{
static const XMVECTORF32 s_chromaKey = { 0.f, 1.f, 0.f, 0.f };
static const XMVECTORF32 s_tolerance = { 0.2f, 0.2f, 0.2f, 0.f };
UNREFERENCED_PARAMETER(y);
for (size_t j = 0; j < width; ++j)
{
XMVECTOR value = inPixels[j];
if (XMVector3NearEqual(value, s_chromaKey, s_tolerance))
{
value = g_XMZero;
}
else
{
value = XMVectorSelect(g_XMOne, value, g_XMSelect1110);
}
outPixels[j] = value;
}
}, result);
if (FAILED(hr))
...
Here is an example for applying a tonemap operator:
XMVECTOR maxLum = XMVectorZero();
HRESULT hr = EvaluateImage(*image.GetImage(0, 0, 0),
[&](const XMVECTOR* pixels, size_t width, size_t y)
{
UNREFERENCED_PARAMETER(y);
for (size_t j = 0; j < width; ++j)
{
static const XMVECTORF32 s_luminance = { 0.3f, 0.59f, 0.11f, 0.f };
XMVECTOR v = *pixels++;
v = XMVector3Dot(v, s_luminance);
maxLum = XMVectorMax(v, maxLum);
}
});
if (FAILED(hr))
...
maxLum = XMVectorMultiply(maxLum, maxLum);
ScratchImage result;
hr = TransformImage(image->GetImages(), image->GetImageCount(), image->GetMetadata(),
[](XMVECTOR* outPixels, const XMVECTOR* inPixels, size_t width, size_t y)
{
UNREFERENCED_PARAMETER(y);
for (size_t j = 0; j < width; ++j)
{
XMVECTOR value = inPixels[j];
XMVECTOR scale = XMVectorDivide(
XMVectorAdd(g_XMOne, XMVectorDivide(value, maxLum)),
XMVectorAdd(g_XMOne, value));
XMVECTOR nvalue = XMVectorMultiply(value, scale);
value = XMVectorSelect(value, nvalue, g_XMSelect1110);
outPixels[j] = value;
}
}, result);
if (FAILED(hr))
...
The user-supplied function always reads & writes DXGI_FORMAT_R32G32B32A32_FLOAT
data in the scanlines.
Block compressed formats are not supported. See Decompress.
This function cannot operate directly on planar format image. See ConvertToSinglePlane for a method for converting planar data to a format that is supported by this routine.
All content and source code for this package are subject to the terms of the MIT License.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
- Universal Windows Platform apps
- Windows desktop apps
- Windows 11
- Windows 10
- Windows 8.1
- Windows 7 Service Pack 1
- Xbox One
- Xbox Series X|S
- Windows Subsystem for Linux
- Visual Studio 2022
- Visual Studio 2019 (16.11)
- clang/LLVM v12 - v18
- GCC 10.5, 11.4, 12.3
- MinGW 12.2, 13.2
- CMake 3.20
DirectX Tool Kit for DirectX 11