NDEVR
API Documentation
VulkanRenderDefinition.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Graphics
28File: VulkanRenderDefinition
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "VulkanDefines.h"
34#include "VulkanDevice.h"
35#include "Base/Headers/Pointer.hpp"
36#include "Base/Headers/Buffer.hpp"
37struct VkAttachmentDescription;
38DEFINE_NON_DISPATCHABLE_HANDLE(VkRenderPass);
39namespace NDEVR
40{
84}
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
Provides a constant, unmodifiable pointer that has shared ownership of a dynamically allocated object...
Definition Pointer.hpp:276
A hash-based key-value store, useful for quick associative lookups.
Definition Dictionary.h:64
Provides a modifiable pointer that has shared ownership of a dynamically allocated object.
Definition Pointer.hpp:356
VulkanRenderDefinition(const DynamicPointer< VulkanDevice > &instance)
Constructs a render definition for the given device.
Dictionary< uint04, VkRenderPass > m_render_pass_grab
Render passes for grab images, keyed by multisample count.
~VulkanRenderDefinition()
Destructor.
bool m_use_depth
Whether depth testing is enabled for these render passes.
VkFormat getSwapChainImageFormat() const
Returns the swap chain image format.
Dictionary< uint04, VkRenderPass > m_render_pass_khr
Render passes for KHR swap chain images, keyed by multisample count.
VkFormat m_swap_chain_image_format
The image format used by the swap chain.
void setSwapChainImageFormat(VkFormat format)
Sets the swap chain image format.
VkRenderPass renderPass(uint04 multisample, bool is_grab_image) const
Returns the render pass for the given configuration.
ConstPointer< VulkanDevice > m_device
The Vulkan device.
void cleanup()
Releases all render pass resources.
Buffer< VkAttachmentDescription, BufferAllocator< VkAttachmentDescription, 64, true > > getAttachments(uint04 multisample_count, bool is_grab_image, uint08 format) const
Returns the attachment descriptions for a render pass configuration.
void createRenderPass(uint04 multisample, bool is_grab_image)
Creates a render pass with the given multisample count.
void setDevice(const ConstPointer< VulkanDevice > &instance)
Sets the Vulkan device.
The primary namespace for the NDEVR SDK.
uint64_t uint08
-Defines an alias representing an 8 byte, unsigned integer
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...