A library used to initialize, create, and manage a DirectX11 rendering context.
More...
#include <GDirectX11Surface.h>
A library used to initialize, create, and manage a DirectX11 rendering context.
This library automates the creation of a basic DirectX11 rendering context, and is capable of accepting special requests that can guide the initialization to support requested options. GDirectX11Surface is a GListener, which allows it to receive events from a registered broadcaster and react accordingly.
◆ GetAspectRatio()
| virtual GReturn GW::GRAPHICS::GDirectX11Surface::GetAspectRatio |
( |
float & |
_outRatio | ) |
|
|
pure virtual |
Returns the aspect ratio for the current window.
- Parameters
-
| [out] | _outRatio | Will contain the calculated aspect ratio.
|
- Return values
-
| SUCCESS | The current aspect ratio was calculated and returned. |
| FAILURE | No active GWindow exists to calculate an aspect ratio from. |
◆ GetContext()
| virtual GReturn GW::GRAPHICS::GDirectX11Surface::GetContext |
( |
void ** |
_outContext | ) |
|
|
pure virtual |
Returns the address of the current ID3D11DeviceContext.
- Parameters
-
| [out] | _outContext | Will contain the address of the context. |
- Return values
-
| SUCCESS | A DirectX11 contexts exists and was returned. |
| FAILURE | No context exists to retrieve. |
◆ GetDepthStencilView()
| virtual GReturn GW::GRAPHICS::GDirectX11Surface::GetDepthStencilView |
( |
void ** |
_outDepthStencilView | ) |
|
|
pure virtual |
Returns the address of the current ID3D11DepthStencilView.
A Depth Stencil View will only be created if requested as a special option when the 'Initialize' method is called.
- Parameters
-
| [out] | _outDepthStencilView | Will contain the address of the depth stencil view. |
- Return values
-
| SUCCESS | A DirectX11 depth stencil view exists and was returned. |
| FAILURE | No depth stencil view exists to retrieve. |
◆ GetDevice()
| virtual GReturn GW::GRAPHICS::GDirectX11Surface::GetDevice |
( |
void ** |
_outDevice | ) |
|
|
pure virtual |
Returns the address of the current ID3D11Device.
- Parameters
-
| [out] | _outDevice | Will contain the address of the device. |
- Return values
-
| SUCCESS | A DirectX11 device exists and was returned. |
| FAILURE | No device exists to retrieve. |
◆ GetRenderTarget()
| virtual GReturn GW::GRAPHICS::GDirectX11Surface::GetRenderTarget |
( |
void ** |
_outRenderTarget | ) |
|
|
pure virtual |
Returns the address of the current ID3D11RenderTargetView.
- Parameters
-
| [out] | _outRenderTarget | Will contain the address of the render target view. |
- Return values
-
| SUCCESS | A DirectX11 render target view exists and was returned. |
| FAILURE | No render target view exists to retrieve. |
◆ GetSwapchain()
| virtual GReturn GW::GRAPHICS::GDirectX11Surface::GetSwapchain |
( |
void ** |
_outSwapchain | ) |
|
|
pure virtual |
Returns the address of the current IDXGISwapChain.
- Parameters
-
| [out] | _outSwapchain | Will contain the address of the swap chain. |
- Return values
-
| SUCCESS | A DirectX11 swap chain exists and was returned. |
| FAILURE | No swap chain exists to retrieve. |
The documentation for this class was generated from the following file:
Public Member Functions inherited from GW::CORE::GListener