Magnum::Vk::ImageCreateInfoCubeMap class new in Git master
#include <Magnum/Vk/ImageCreateInfo.h>

Convenience constructor for cube map images.

Compared to the base ImageCreateInfo constructor creates an image of type VK_IMAGE_TYPE_2D with the last size component set to 1, layers set to 6 and flags additionally having Flag::CubeCompatible. You can use any of ImageViewCreateInfo2D, ImageViewCreateInfo2DArray, ImageViewCreateInfoCubeMap or ImageViewCreateInfoCubeMapArray for view creation, although the last one will need to have exactly six layers, and requires DeviceFeature::ImageCubeArray to be enabled.

Note that same as with the ImageCreateInfo::ImageCreateInfo(VkImageType, ImageUsages, PixelFormat, const Vector3i&, Int, Int, Int, ImageLayout, Flags) constructor, at least one ImageUsage value is required.

Base classes

class ImageCreateInfo new in Git master
Image creation info.

Constructors, destructors, conversion operators

ImageCreateInfoCubeMap(ImageUsages usages, PixelFormat format, const Vector2i& size, Int levels, Int samples = 1, ImageLayout initialLayout = ImageLayout::Undefined, Flags flags = {}) explicit
Constructor.
ImageCreateInfoCubeMap(ImageUsages usages, Magnum::PixelFormat format, const Vector2i& size, Int levels, Int samples = 1, ImageLayout initialLayout = ImageLayout::Undefined, Flags flags = {}) explicit
ImageCreateInfoCubeMap(ImageUsages usages, Magnum::CompressedPixelFormat format, const Vector2i& size, Int levels, Int samples = 1, ImageLayout initialLayout = ImageLayout::Undefined, Flags flags = {}) explicit
ImageCreateInfoCubeMap(ImageUsages usages, PixelFormat format, const Vector2i& size, Int levels, Int samples, Flags flags) explicit
ImageCreateInfoCubeMap(ImageUsages usages, Magnum::PixelFormat format, const Vector2i& size, Int levels, Int samples, Flags flags) explicit
ImageCreateInfoCubeMap(ImageUsages usages, Magnum::CompressedPixelFormat format, const Vector2i& size, Int levels, Int samples, Flags flags) explicit

Function documentation

Magnum::Vk::ImageCreateInfoCubeMap::ImageCreateInfoCubeMap(ImageUsages usages, Magnum::PixelFormat format, const Vector2i& size, Int levels, Int samples = 1, ImageLayout initialLayout = ImageLayout::Undefined, Flags flags = {}) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Magnum::Vk::ImageCreateInfoCubeMap::ImageCreateInfoCubeMap(ImageUsages usages, Magnum::CompressedPixelFormat format, const Vector2i& size, Int levels, Int samples = 1, ImageLayout initialLayout = ImageLayout::Undefined, Flags flags = {}) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Magnum::Vk::ImageCreateInfoCubeMap::ImageCreateInfoCubeMap(ImageUsages usages, PixelFormat format, const Vector2i& size, Int levels, Int samples, Flags flags) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Equivalent to the above with initialLayout set to ImageLayout::Undefined.

Magnum::Vk::ImageCreateInfoCubeMap::ImageCreateInfoCubeMap(ImageUsages usages, Magnum::PixelFormat format, const Vector2i& size, Int levels, Int samples, Flags flags) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Magnum::Vk::ImageCreateInfoCubeMap::ImageCreateInfoCubeMap(ImageUsages usages, Magnum::CompressedPixelFormat format, const Vector2i& size, Int levels, Int samples, Flags flags) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.