blob: eea6697c20588d0189984ce6b2585531c1fa7265 [file] [log] [blame]
Adam Sawickiae5c4662019-01-02 10:23:35 +01001//
Adam Sawicki50882502020-02-07 16:51:31 +01002// Copyright (c) 2017-2020 Advanced Micro Devices, Inc. All rights reserved.
Adam Sawickiae5c4662019-01-02 10:23:35 +01003//
4// Permission is hereby granted, free of charge, to any person obtaining a copy
5// of this software and associated documentation files (the "Software"), to deal
6// in the Software without restriction, including without limitation the rights
7// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8// copies of the Software, and to permit persons to whom the Software is
9// furnished to do so, subject to the following conditions:
10//
11// The above copyright notice and this permission notice shall be included in
12// all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20// THE SOFTWARE.
21//
22
Adam Sawickif1a793c2018-03-13 15:42:22 +010023#ifndef VMA_USAGE_H_
24#define VMA_USAGE_H_
25
26#ifdef _WIN32
27
28#define NOMINMAX
29#define WIN32_LEAN_AND_MEAN
30#include <Windows.h>
31#define VK_USE_PLATFORM_WIN32_KHR
32
Andras Nyiscsak641a16c2019-11-18 15:09:34 +010033#else // #ifdef _WIN32
34
35#include <vulkan/vulkan.h>
36
37#endif // #ifdef _WIN32
38
39#ifdef _MSVC_LANG
40
Adam Sawickie8b01482018-12-06 14:47:59 +010041// Uncomment to test including `vulkan.h` on your own before including VMA.
42//#include <vulkan/vulkan.h>
Adam Sawickif1a793c2018-03-13 15:42:22 +010043
44/*
45In every place where you want to use Vulkan Memory Allocator, define appropriate
46macros if you want to configure the library and then include its header to
47include all public interface declarations. Example:
48*/
49
Adam Sawicki212a4a62018-06-14 15:44:45 +020050//#define VMA_HEAVY_ASSERT(expr) assert(expr)
Adam Sawicki0a607132018-08-24 11:18:41 +020051//#define VMA_USE_STL_CONTAINERS 1
Adam Sawicki4f919392018-04-03 13:45:39 +020052//#define VMA_DEDICATED_ALLOCATION 0
Adam Sawicki212a4a62018-06-14 15:44:45 +020053//#define VMA_DEBUG_MARGIN 16
54//#define VMA_DEBUG_DETECT_CORRUPTION 1
Adam Sawickie44c6262018-06-15 14:30:39 +020055//#define VMA_DEBUG_INITIALIZE_ALLOCATIONS 1
Adam Sawicki2024cc52019-07-02 15:19:05 +020056//#define VMA_RECORDING_ENABLED 1
Adam Sawicki0a607132018-08-24 11:18:41 +020057//#define VMA_DEBUG_MIN_BUFFER_IMAGE_GRANULARITY 256
Adam Sawickif863a1d2018-10-10 16:43:44 +020058//#define VMA_USE_STL_SHARED_MUTEX 0
59//#define VMA_DEBUG_GLOBAL_MUTEX 1
Adam Sawicki4ac8ff82019-11-18 14:47:33 +010060//#define VMA_MEMORY_BUDGET 0
Adam Sawicki10f68cb2019-11-22 17:41:59 +010061
Adam Sawickicdd30bb2020-01-20 17:19:41 +010062//#define VMA_VULKAN_VERSION 1002000 // Vulkan 1.2
Adam Sawicki1296e2d2019-11-25 11:13:53 +010063#define VMA_VULKAN_VERSION 1001000 // Vulkan 1.1
64//#define VMA_VULKAN_VERSION 1000000 // Vulkan 1.0
Adam Sawicki10f68cb2019-11-22 17:41:59 +010065
Adam Sawickifd366b62019-01-24 15:26:43 +010066/*
67#define VMA_DEBUG_LOG(format, ...) do { \
68 printf(format, __VA_ARGS__); \
69 printf("\n"); \
70 } while(false)
71*/
Adam Sawicki212a4a62018-06-14 15:44:45 +020072
Adam Sawickif1a793c2018-03-13 15:42:22 +010073#pragma warning(push, 4)
74#pragma warning(disable: 4127) // conditional expression is constant
75#pragma warning(disable: 4100) // unreferenced formal parameter
76#pragma warning(disable: 4189) // local variable is initialized but not referenced
Adam Sawicki5afe7842019-07-26 15:09:07 +020077#pragma warning(disable: 4324) // structure was padded due to alignment specifier
Adam Sawickif1a793c2018-03-13 15:42:22 +010078
Andras Nyiscsak641a16c2019-11-18 15:09:34 +010079#endif // #ifdef _MSVC_LANG
Adam Sawickif1a793c2018-03-13 15:42:22 +010080
Adam Sawickic7d1b582018-08-27 12:30:53 +020081#ifdef __clang__
82 #pragma clang diagnostic push
83 #pragma clang diagnostic ignored "-Wtautological-compare" // comparison of unsigned expression < 0 is always false
Andras Nyiscsak641a16c2019-11-18 15:09:34 +010084 #pragma clang diagnostic ignored "-Wunused-private-field"
85 #pragma clang diagnostic ignored "-Wunused-parameter"
86 #pragma clang diagnostic ignored "-Wmissing-field-initializers"
Adam Sawickifacf05e2020-04-08 17:09:59 +020087 #pragma clang diagnostic ignored "-Wnullability-completeness"
Adam Sawickic7d1b582018-08-27 12:30:53 +020088#endif
89
Adam Sawickif1a793c2018-03-13 15:42:22 +010090#include "vk_mem_alloc.h"
91
Adam Sawickic7d1b582018-08-27 12:30:53 +020092#ifdef __clang__
93 #pragma clang diagnostic pop
94#endif
95
Andras Nyiscsak641a16c2019-11-18 15:09:34 +010096#ifdef _MSVC_LANG
97 #pragma warning(pop)
Adam Sawickif1a793c2018-03-13 15:42:22 +010098#endif
Andras Nyiscsak641a16c2019-11-18 15:09:34 +010099
Adam Sawicki8ef0d202020-03-02 15:43:47 +0100100#endif