Vulkan-Docs/doc/specs/vulkan/man/vkCreateImageView.txt
Jon Leech 75bbb5f4d5 Change log for April 29, 2016 Vulkan 1.0.12 spec update:
* Bump API patch number and header version number to 12 for this
    update.

Github Issues:

  * Change valid usage statements intended to be "sub-points" to
    be actual sub-points (public issue 66).
  * Replace double negation in description of
    slink:VkRenderPassBeginInfo::pname:pClearValues (based on public
    merge 142).
  * Cleanup minor typos in spec, ref pages and XML, including those
    proposed in public pull requests 144, 150, 151, 167, 168, 181, and
    186.
  * Use *strict subset* in describing the partial order of memory
    property types for slink:VkMemoryType, and update the style guide
    accordingly (public issue 190).
  * Fix various "a image" -> "an image" typos (public issue 191).
  * Note in the <<fundamentals-validusage,Valid Usage>> and
    <<extensions-interactions,Extension Interactions>> sections that
    structures defined by extensions which may be passed in structure
    chains using the ptext:pNext member must: include initial
    ptext:sType and ptext:pNext members (public issue 192).

Internal Issues:

  * Remove duplicate language from the description of the pname:fence
    parameter to flink:vkQueueSubmit and improve validity language
    (internal issue 91).
  * Added documentation for "optional" attribute to XML readme.tex/pdf
    (internal issue 149).
  * Clarify the host-side data validity rules and behavior of
    flink:vkFlushMappedMemoryRanges and
    flink:vkInvalidateMappedMemoryRanges (internal issue 266).

Other Commits:

  * Added clarification to flink:vkCmdFillBuffer regarding the use of
    ename:VK_WHOLE_SIZE.
  * Fixed and documented implementation of "validextensionstructs"
    attribute. in XML processing scripts and readme.tex/pdf.
  * Add missing validity statements to flink:vkResetEvent and
    flink:vkCmdResetEvent.
  * Fix validity for the
    ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag.
    Correct all the draw/dispatch commands to mention optimally tiled
    images as well as linear tiled images, and say image VIEWS instead
    of images. Add validity statement to flink:vkCmdBlitImage
  * Replace the {apiname} macro with hardcoded "Vulkan", now that we've
    committed to that name.
  * Add the VK_AMD_rasterization_order extension to vk.xml.
2016-04-29 14:53:46 +02:00

60 lines
2.0 KiB
Plaintext

vkCreateImageView(3)
====================
Name
----
vkCreateImageView - Create an image view from an existing image.
C Specification
---------------
include::../protos/vkCreateImageView.txt[]
Parameters
----------
pname:device::
Logical device which owns the image.
pname:pCreateInfo::
Specifies properties of the new view.
pname:pView::
Returns the requested object.
Description
-----------
fname:vkCreateImageView creates a new view of a source image in a compatible format, allowing casting
of image data from one format to another. Image views may be bound into descriptor sets to allow them
to be accessed in shaders, or be bound as color attachments. pname:device specifies the device that
is to be used to create the new view. pname:pCreateInfo is a pointer to an instance of the
slink:VkImageViewCreateInfo structure defining the properties of the new view object. The definition
of slink:VkImageViewCreateInfo is:
include::../structs/VkImageViewCreateInfo.txt[]
The pname:sType member of pname:pCreateInfo should be ename:VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO.
The pname:image member contains the handle to the parent object of which to create a view. pname:viewType
specifies the type of view to be created and should be a member of the elink:VkImageViewType enumeration,
the definition of which is:
include::../enums/VkImageViewType.txt[]
The pname:format member of pname:pCreateInfo specifies the image format for the newly created view and
should be compatible with the base format of the parent image specified in pname:image. The pname:components
member is an instance of the slink:VkComponentMapping structure which defines component ordering for data
read from the view. The pname:subresourceRange member of the pname:pCreateInfo specifies the
range of the parent resource to be visible through the new view.
The pname:flags member of pname:pCreateInfo is reserved and must be 0.
include::../validity/protos/vkCreateImageView.txt[]
See Also
--------
flink:vkCreateImage, flink:vkCreateBuffer, flink:vkCreateBufferView
include::footer.txt[]