MAGE  v0.171.0
Matthias Advanced Game Engine
mage::rendering::Viewport Class Reference

#include <viewport.hpp>

Public Member Functions

 Viewport () noexcept
 
 Viewport (const U32x2 &size) noexcept
 
 Viewport (const U32x2 &size, AntiAliasing aa) noexcept
 
 Viewport (D3D11_VIEWPORT viewport) noexcept
 
 Viewport (const Viewport &viewport) noexcept=default
 
 Viewport (Viewport &&viewport) noexcept=default
 
 Viewport (Viewport viewport, AntiAliasing aa) noexcept
 
 ~Viewport ()=default
 
Viewportoperator= (const Viewport &viewport) noexcept=default
 
Viewportoperator= (Viewport &&viewport) noexcept=default
 
void Bind (ID3D11DeviceContext &device_context) const noexcept
 
const D3D11_VIEWPORT & GetViewport () const noexcept
 
void SetViewport (D3D11_VIEWPORT viewport) noexcept
 
const S32x2 GetTopLeft () const noexcept
 
void SetTopLeft (S32 x, S32 y) noexcept
 
void SetTopLeft (const S32x2 &top_left) noexcept
 
const U32x2 GetSize () const noexcept
 
void SetSize (U32 x, U32 y) noexcept
 
void SetSize (const U32x2 &size) noexcept
 
const F32x2 GetDepthRange () const noexcept
 
void SetDepthRange (F32 min_depth, F32 max_depth) noexcept
 
void SetDepthRange (const F32x2 &range) noexcept
 
const XMMATRIX XM_CALLCONV GetViewportTransform () const noexcept
 

Static Private Member Functions

static const D3D11_VIEWPORT GetMaxViewport (const U32x2 &size) noexcept
 
static const D3D11_VIEWPORT GetMaxViewport (const U32x2 &size, AntiAliasing aa) noexcept
 

Private Attributes

D3D11_VIEWPORT m_viewport
 

Detailed Description

A class of viewports.

Constructor & Destructor Documentation

◆ Viewport() [1/7]

mage::rendering::Viewport::Viewport ( )
explicitnoexcept

◆ Viewport() [2/7]

mage::rendering::Viewport::Viewport ( const U32x2 size)
explicitnoexcept

◆ Viewport() [3/7]

mage::rendering::Viewport::Viewport ( const U32x2 size,
AntiAliasing  aa 
)
explicitnoexcept

◆ Viewport() [4/7]

mage::rendering::Viewport::Viewport ( D3D11_VIEWPORT  viewport)
explicitnoexcept

◆ Viewport() [5/7]

mage::rendering::Viewport::Viewport ( const Viewport viewport)
defaultnoexcept

◆ Viewport() [6/7]

mage::rendering::Viewport::Viewport ( Viewport &&  viewport)
defaultnoexcept

◆ Viewport() [7/7]

mage::rendering::Viewport::Viewport ( Viewport  viewport,
AntiAliasing  aa 
)
explicitnoexcept

◆ ~Viewport()

mage::rendering::Viewport::~Viewport ( )
default

Member Function Documentation

◆ Bind()

void mage::rendering::Viewport::Bind ( ID3D11DeviceContext &  device_context) const
noexcept

◆ GetDepthRange()

const F32x2 mage::rendering::Viewport::GetDepthRange ( ) const
noexcept

◆ GetMaxViewport() [1/2]

static const D3D11_VIEWPORT mage::rendering::Viewport::GetMaxViewport ( const U32x2 size)
staticprivatenoexcept

◆ GetMaxViewport() [2/2]

static const D3D11_VIEWPORT mage::rendering::Viewport::GetMaxViewport ( const U32x2 size,
AntiAliasing  aa 
)
staticprivatenoexcept

◆ GetSize()

const U32x2 mage::rendering::Viewport::GetSize ( ) const
noexcept

◆ GetTopLeft()

const S32x2 mage::rendering::Viewport::GetTopLeft ( ) const
noexcept

◆ GetViewport()

const D3D11_VIEWPORT& mage::rendering::Viewport::GetViewport ( ) const
noexcept

Returns the viewport of this viewport.

Returns
A reference to the viewport of this viewport.

◆ GetViewportTransform()

const XMMATRIX XM_CALLCONV mage::rendering::Viewport::GetViewportTransform ( ) const
noexcept

◆ operator=() [1/2]

Viewport& mage::rendering::Viewport::operator= ( const Viewport viewport)
defaultnoexcept

◆ operator=() [2/2]

Viewport& mage::rendering::Viewport::operator= ( Viewport &&  viewport)
defaultnoexcept

◆ SetDepthRange() [1/2]

void mage::rendering::Viewport::SetDepthRange ( F32  min_depth,
F32  max_depth 
)
noexcept

◆ SetDepthRange() [2/2]

void mage::rendering::Viewport::SetDepthRange ( const F32x2 range)
noexcept

◆ SetSize() [1/2]

void mage::rendering::Viewport::SetSize ( U32  x,
U32  y 
)
noexcept

◆ SetSize() [2/2]

void mage::rendering::Viewport::SetSize ( const U32x2 size)
noexcept

◆ SetTopLeft() [1/2]

void mage::rendering::Viewport::SetTopLeft ( S32  x,
S32  y 
)
noexcept

◆ SetTopLeft() [2/2]

void mage::rendering::Viewport::SetTopLeft ( const S32x2 top_left)
noexcept

◆ SetViewport()

void mage::rendering::Viewport::SetViewport ( D3D11_VIEWPORT  viewport)
noexcept

Sets the viewport of this viewport to the given viewport.

Parameters
[in]viewportThe viewport.

Member Data Documentation

◆ m_viewport

D3D11_VIEWPORT mage::rendering::Viewport::m_viewport
private

The viewport of this viewport.