Home | History | Annotate | Download | only in layers
      1 /* Copyright (c) 2015-2016 The Khronos Group Inc.
      2  * Copyright (c) 2015-2016 Valve Corporation
      3  * Copyright (c) 2015-2016 LunarG, Inc.
      4  *
      5  * Licensed under the Apache License, Version 2.0 (the "License");
      6  * you may not use this file except in compliance with the License.
      7  * You may obtain a copy of the License at
      8  *
      9  *     http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  * Unless required by applicable law or agreed to in writing, software
     12  * distributed under the License is distributed on an "AS IS" BASIS,
     13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  * See the License for the specific language governing permissions and
     15  * limitations under the License.
     16  *
     17  * Author: Mark Lobodzinski <mark (at) lunarg.com>
     18  * Author: Mike Stroyan <mike (at) LunarG.com>
     19  * Author: Tobin Ehlis <tobin (at) lunarg.com>
     20  */
     21 
     22 #ifndef IMAGE_H
     23 #define IMAGE_H
     24 #include "vulkan/vulkan.h"
     25 #include "vk_layer_config.h"
     26 #include "vk_layer_logging.h"
     27 
     28 // Image ERROR codes
     29 enum IMAGE_ERROR {
     30     IMAGE_NONE,                             // Used for INFO & other non-error messages
     31     IMAGE_FORMAT_UNSUPPORTED,               // Request to create Image or RenderPass with a format that is not supported
     32     IMAGE_RENDERPASS_INVALID_ATTACHMENT,    // Invalid image layouts and/or load/storeOps for an attachment when creating RenderPass
     33     IMAGE_RENDERPASS_INVALID_DS_ATTACHMENT, // If no depth/stencil attachment for a RenderPass, verify that subpass DS attachment
     34                                             // is set to UNUSED
     35     IMAGE_INVALID_IMAGE_ASPECT,             // Image aspect mask bits are invalid for this API call
     36     IMAGE_MISMATCHED_IMAGE_ASPECT,          // Image aspect masks for source and dest images do not match
     37     IMAGE_VIEW_CREATE_ERROR,                // Error occurred trying to create Image View
     38     IMAGE_MISMATCHED_IMAGE_TYPE,            // Image types for source and dest images do not match
     39     IMAGE_MISMATCHED_IMAGE_FORMAT,          // Image formats for source and dest images do not match
     40     IMAGE_INVALID_RESOLVE_SAMPLES,          // Image resolve source samples less than two or dest samples greater than one
     41     IMAGE_INVALID_FORMAT,                   // Operation specifies an invalid format, or there is a format mismatch
     42     IMAGE_INVALID_FILTER,                   // Operation specifies an invalid filter setting
     43     IMAGE_INVALID_IMAGE_RESOURCE,           // Image resource/subresource called with invalid setting
     44     IMAGE_INVALID_FORMAT_LIMITS_VIOLATION,  // Device limits for this format have been exceeded
     45     IMAGE_INVALID_LAYOUT,                   // Operation specifies an invalid layout
     46     IMAGE_INVALID_EXTENTS,                  // Operation specifies invalid image extents
     47     IMAGE_INVALID_USAGE,                    // Image was created without necessary usage for operation
     48 };
     49 
     50 struct IMAGE_STATE {
     51     uint32_t mipLevels;
     52     uint32_t arraySize;
     53     VkFormat format;
     54     VkSampleCountFlagBits samples;
     55     VkImageType imageType;
     56     VkExtent3D extent;
     57     VkImageCreateFlags flags;
     58     VkImageUsageFlags usage;
     59     IMAGE_STATE()
     60         : mipLevels(0), arraySize(0), format(VK_FORMAT_UNDEFINED), samples(VK_SAMPLE_COUNT_1_BIT),
     61           imageType(VK_IMAGE_TYPE_RANGE_SIZE), extent{}, flags(0), usage(0){};
     62     IMAGE_STATE(const VkImageCreateInfo *pCreateInfo)
     63         : mipLevels(pCreateInfo->mipLevels), arraySize(pCreateInfo->arrayLayers), format(pCreateInfo->format),
     64           samples(pCreateInfo->samples), imageType(pCreateInfo->imageType), extent(pCreateInfo->extent), flags(pCreateInfo->flags),
     65           usage(pCreateInfo->usage){};
     66 };
     67 
     68 #endif // IMAGE_H
     69