Graphics subsystem. Manages the application window, rendering state and GPU resources.
More...
|
| Graphics (Context *context) |
| Construct.
|
|
| ~Graphics () override |
| Destruct. Release the Direct3D11 device and close the window.
|
|
void | Configure (const GraphicsSettings &settings) |
| Configure before initial setup.
|
|
void | SetWindowTitle (const ea::string &windowTitle) |
|
void | SetWindowIcon (Image *windowIcon) |
|
void | SetWindowPosition (const IntVector2 &position) |
|
void | SetWindowPosition (int x, int y) |
| Set window position. Sets initial position if window is not created yet.
|
|
bool | SetScreenMode (const WindowSettings &windowSettings) |
|
bool | SetWindowModes (const WindowSettings &primarySettings, const WindowSettings &secondarySettings) |
|
bool | SetDefaultWindowModes (const WindowSettings &commonSettings) |
| Set default window modes. Return true if successful.
|
|
bool | SetMode (int width, int height, bool fullscreen, bool borderless, bool resizable, bool highDPI, bool vsync, bool tripleBuffer, int multiSample, int monitor, int refreshRate) |
| Set default window modes. Deprecated. Return true if successful.
|
|
bool | SetMode (int width, int height) |
| Set screen resolution only. Deprecated. Return true if successful.
|
|
void | InitializePipelineStateCache (const FileIdentifier &fileName) |
|
void | SavePipelineStateCache (const FileIdentifier &fileName) |
| Save pipeline state cache.
|
|
bool | ToggleFullscreen () |
| Toggle between full screen and windowed mode. Return true if successful.
|
|
void | Close () |
| Close the window.
|
|
bool | TakeScreenShot (Image &destImage) |
| Take a screenshot. Return true if successful.
|
|
bool | BeginFrame () |
| Begin frame rendering. Return true if device available and can render.
|
|
void | EndFrame () |
| End frame rendering and swap buffers.
|
|
void | Clear (ClearTargetFlags flags, const Color &color=Color::TRANSPARENT_BLACK, float depth=1.0f, unsigned stencil=0) |
| Clear any or all of rendertarget, depth buffer and stencil buffer.
|
|
void | ResetRenderTargets () |
| Reset all rendertargets, depth-stencil surface and viewport.
|
|
bool | IsInitialized () const |
|
void * | GetExternalWindow () const |
| Return OS-specific external window handle. Null if not in use.
|
|
SDL_Window * | GetWindow () const |
| Return SDL window.
|
|
const ea::string & | GetWindowTitle () const |
|
const ea::string & | GetApiName () const |
|
IntVector2 | GetWindowPosition () const |
|
const WindowSettings & | GetWindowSettings () const |
| Return screen mode parameters.
|
|
const IntVector2 | GetSwapChainSize () const |
| Return swap chain size.
|
|
int | GetWidth () const |
|
int | GetHeight () const |
|
int | GetMultiSample () const |
|
IntVector2 | GetSize () const |
|
bool | GetFullscreen () const |
|
bool | GetBorderless () const |
|
bool | GetResizable () const |
|
bool | GetVSync () const |
|
int | GetRefreshRate () const |
| Return refresh rate when using vsync in fullscreen.
|
|
int | GetMonitor () const |
| Return the current monitor index. Effective on in fullscreen.
|
|
bool | GetSRGB () const |
|
TextureFormat | GetDummyColorFormat () const |
| Return dummy color texture format for shadow maps. Is "NULL" (consume no video memory) if supported.
|
|
TextureFormat | GetShadowMapFormat () const |
| Return shadow map depth texture format, or 0 if not supported.
|
|
TextureFormat | GetHiresShadowMapFormat () const |
| Return 24-bit shadow map depth texture format, or 0 if not supported.
|
|
bool | GetInstancingSupport () const |
|
bool | GetHardwareShadowSupport () const |
|
ea::vector< IntVector3 > | GetResolutions (int monitor) const |
|
unsigned | FindBestResolutionIndex (int monitor, int width, int height, int refreshRate) const |
| Return index of the best resolution for requested width, height and refresh rate.
|
|
IntVector2 | GetDesktopResolution (int monitor) const |
|
int | GetMonitorCount () const |
|
int | GetCurrentMonitor () const |
|
bool | GetMaximized () const |
|
Vector3 | GetDisplayDPI (int monitor=0) const |
|
ShaderVariation * | GetShader (ShaderType type, const ea::string &name, const ea::string &defines=EMPTY_STRING) const |
| Return a shader variation by name and defines.
|
|
ShaderVariation * | GetShader (ShaderType type, const char *name, const char *defines) const |
| Return a shader variation by name and defines.
|
|
IntVector2 | GetRenderTargetDimensions () const |
| Return current rendertarget width and height.
|
|
void | OnWindowResized () |
| Window was resized through user interaction. Called by Input subsystem.
|
|
void | OnWindowMoved () |
| Window was moved through user interaction. Called by Input subsystem.
|
|
void | Restore () |
|
void | Maximize () |
| Maximize the window.
|
|
void | Minimize () |
| Minimize the window.
|
|
void | Raise () const |
| Raises window if it was minimized.
|
|
void * | GetSDLWindow () |
| Get the SDL_Window as a void* to avoid having to include the graphics implementation.
|
|
|
RenderBackend | GetRenderBackend () const |
|
const GraphicsSettings & | GetSettings () const |
|
| Object (Context *context) |
| Construct.
|
|
| ~Object () override |
| Destruct. Clean up self from event sender & receiver structures.
|
|
virtual StringHash | GetType () const =0 |
|
virtual const ea::string & | GetTypeName () const =0 |
|
virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info.
|
|
virtual bool | IsInstanceOf (StringHash type) const =0 |
| Check whether current instance implements specified type.
|
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
|
virtual void | SerializeInBlock (Archive &archive) |
| Serialize content from/to archive. May throw ArchiveException.
|
|
template<typename T > |
bool | IsInstanceOf () const |
| Check current instance is type of specified class.
|
|
template<typename T > |
T * | Cast () |
| Cast the object to specified most derived class.
|
|
template<typename T > |
const T * | Cast () const |
| Cast the object to specified most derived class.
|
|
void | SubscribeToEventManual (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
|
void | SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
|
template<class T > |
void | SubscribeToEvent (StringHash eventType, T handler) |
| Subscribe to an event that can be sent by any sender.
|
|
template<class T > |
void | SubscribeToEvent (Object *sender, StringHash eventType, T handler) |
| Subscribe to a specific sender's event.
|
|
void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event.
|
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event.
|
|
void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events.
|
|
void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events.
|
|
void | UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions) |
| Unsubscribe from all events except those listed.
|
|
void | UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions) |
| Unsubscribe from all events except those with listed senders.
|
|
void | SendEvent (StringHash eventType) |
| Send event to all subscribers.
|
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
|
VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
|
|
template<typename... Args> |
void | SendEvent (StringHash eventType, const Args &... args) |
| Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
|
|
Context * | GetContext () const |
| Return execution context.
|
|
const Variant & | GetGlobalVar (StringHash key) const |
|
const VariantMap & | GetGlobalVars () const |
|
void | SetGlobalVar (StringHash key, const Variant &value) |
|
Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type.
|
|
Object * | GetEventSender () const |
| Return active event sender. Null outside event handling.
|
|
EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling.
|
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender.
|
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event.
|
|
bool | HasEventHandlers () const |
| Return whether has subscribed to any event.
|
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
|
const ea::string & | GetCategory () const |
|
void | SendEvent (StringHash eventType, const VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
|
void | SetBlockEvents (bool block) |
| Block object from sending and receiving events.
|
|
bool | GetBlockEvents () const |
| Return sending and receiving events blocking status.
|
|
| RefCounted () |
| Construct. Allocate the reference count structure and set an initial self weak reference.
|
|
virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
|
| RefCounted (const RefCounted &rhs)=delete |
| Prevent copy construction.
|
|
RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment.
|
|
int | AddRef () |
|
int | ReleaseRef () |
|
int | Refs () const |
|
int | WeakRefs () const |
|
RefCount * | RefCountPtr () const |
| Return pointer to the reference count structure.
|
|
bool | HasScriptObject () const |
| Return true if script runtime object wrapping this native object exists.
|
|
bool | IsScriptStrongRef () const |
| Return true if script reference is strong.
|
|
Graphics subsystem. Manages the application window, rendering state and GPU resources.