vsg 1.1.3
VulkanSceneGraph library
Loading...
Searching...
No Matches
ViewportState.h
1#pragma once
2
3/* <editor-fold desc="MIT License">
4
5Copyright(c) 2018 Robert Osfield
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/state/GraphicsPipeline.h>
16
17namespace vsg
18{
19 using Viewports = std::vector<VkViewport>;
20 using Scissors = std::vector<VkRect2D>;
21
23 class VSG_DECLSPEC ViewportState : public Inherit<GraphicsPipelineState, ViewportState>
24 {
25 public:
28
30 explicit ViewportState(const VkExtent2D& extent);
31
33 ViewportState(int32_t x, int32_t y, uint32_t width, uint32_t height);
34
36 Viewports viewports;
37 Scissors scissors;
38
40 void set(int32_t x, int32_t y, uint32_t width, uint32_t height);
41
43 VkViewport& getViewport();
44
46 VkRect2D& getScissor();
47
48 int compare(const Object& rhs) const override;
49
50 void read(Input& input) override;
51 void write(Output& output) const override;
52 void apply(Context& context, VkGraphicsPipelineCreateInfo& pipelineInfo) const override;
53
54 protected:
55 virtual ~ViewportState();
56 };
57 VSG_type_name(vsg::ViewportState);
58
59} // namespace vsg
Definition Context.h:67
Definition Inherit.h:28
Definition Input.h:44
Definition Object.h:60
Definition Output.h:41
ViewportState encapsulates VkPipelineViewportStateCreateInfo settings passed when setting up Graphics...
Definition ViewportState.h:24
Viewports viewports
VkPipelineViewportStateCreateInfo settings.
Definition ViewportState.h:36
ViewportState(int32_t x, int32_t y, uint32_t width, uint32_t height)
Create ViewportState containing a single Viewport and Scissor pair with specified position and extent...
int compare(const Object &rhs) const override
compare two objects, return -1 if this object is less than rhs, return 0 if it's equal,...
ViewportState(const VkExtent2D &extent)
Create ViewportState containing a single Viewport and Scissor pair with specified extent located at o...
VkRect2D & getScissor()
get or create the first Scissor
VkViewport & getViewport()
get or create the first Viewport
void set(int32_t x, int32_t y, uint32_t width, uint32_t height)
set to a single Viewport and Scissor pair with specified extent