vsg: include/vsg/commands/ClearImage.h Source File

vsg 1.1.3 VulkanSceneGraph library

Loading...
Searching...
No Matches
ClearImage.h
1#pragma once
2
3/* <editor-fold desc="MIT License">
4
5Copyright(c) 2019 Thomas Hogarth
6
7Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8
9The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10
11THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12
13</editor-fold> */
14
15#include <vsg/commands/Command.h>
16#include <vsg/state/Image.h>
17
18namespace vsg
19{
20
22 class VSG_DECLSPEC ClearColorImage : public Inherit<Command, ClearColorImage>
23 {
24 public:
25 using Ranges = std::vector<VkImageSubresourceRange>;
26
27 vsg::ref_ptr<vsg::Image> image;
28 VkImageLayout imageLayout; // imageLayout must be VK_IMAGE_LAYOUT_GENERAL or VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
29 VkClearColorValue color;
30 Ranges ranges;
31
32 void record(CommandBuffer& commandBuffer) const override;
33 };
34 VSG_type_name(vsg::ClearColorImage);
35
37 class VSG_DECLSPEC ClearDepthStencilImage : public Inherit<Command, ClearDepthStencilImage>
38 {
39 public:
40 using Ranges = std::vector<VkImageSubresourceRange>;
41
42 vsg::ref_ptr<vsg::Image> image;
43 VkImageLayout imageLayout; // imageLayout must be VK_IMAGE_LAYOUT_GENERAL or VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
44 VkClearDepthStencilValue depthStencil;
45 Ranges ranges;
46
47 void record(CommandBuffer& commandBuffer) const override;
48 };
49 VSG_type_name(vsg::ClearDepthStencilImage);
50
51} // namespace vsg
vsg::ClearColorImage
ClearColorImage command encapsulates vkCmdClearColorImage functionality and associated settings.
Definition ClearImage.h:23
vsg::ClearDepthStencilImage
ClearDepthStencilImage command encapsulates vkCmdClearDepthStencilImage functionality and associated ...
Definition ClearImage.h:38
vsg::CommandBuffer
CommandBuffer encapsulates VkCommandBuffer.
Definition CommandBuffer.h:27
vsg::Inherit
Definition Inherit.h:28
vsg::ref_ptr
Definition ref_ptr.h:22