VkComponentMapping(3)

# VkComponentMapping(3) Manual Page

## Name

VkComponentMapping - Structure specifying a color component mapping

Loading… please wait.

## C Specification

The `VkComponentMapping` structure is defined as:

    // Provided by VK_VERSION_1_0
    typedef struct VkComponentMapping {
        VkComponentSwizzle    r;
        VkComponentSwizzle    g;
        VkComponentSwizzle    b;
        VkComponentSwizzle    a;
    } VkComponentMapping;

## Members

- `r` is a VkComponentSwizzle specifying the component value placed in the R component of the output vector.

- `g` is a VkComponentSwizzle specifying the component value placed in the G component of the output vector.

- `b` is a VkComponentSwizzle specifying the component value placed in the B component of the output vector.

- `a` is a VkComponentSwizzle specifying the component value placed in the A component of the output vector.

## Description

Valid Usage (Implicit)

- VUID-VkComponentMapping-r-parameter
  `r` must be a valid VkComponentSwizzle value

- VUID-VkComponentMapping-g-parameter
  `g` must be a valid VkComponentSwizzle value

- VUID-VkComponentMapping-b-parameter
  `b` must be a valid VkComponentSwizzle value

- VUID-VkComponentMapping-a-parameter
  `a` must be a valid VkComponentSwizzle value

## See Also

VK_VERSION_1_0, VkAndroidHardwareBufferFormatProperties2ANDROID, VkAndroidHardwareBufferFormatPropertiesANDROID, VkBufferCollectionPropertiesFUCHSIA, VkComponentSwizzle, VkImageViewCreateInfo, VkSamplerBorderColorComponentMappingCreateInfoEXT, VkSamplerYcbcrConversionCreateInfo, VkScreenBufferFormatPropertiesQNX, VkVideoFormatPropertiesKHR

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0