747 lines
35 KiB
XML
747 lines
35 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>SharpDX.Toolkit.Game</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:SharpDX.Toolkit.AssemblyDoc">
|
|
<summary>
|
|
The <see cref="A:SharpDX.Toolkit.Game"/> assembly provides a high level Game API.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.IContentable">
|
|
<summary>
|
|
An interface to load and unload content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IContentable.LoadContent">
|
|
<summary>
|
|
Loads the content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IContentable.UnloadContent">
|
|
<summary>
|
|
Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameGraphicsParameters">
|
|
<summary>
|
|
Describess how data will be displayed to the screen.
|
|
</summary>
|
|
<msdn-id>bb173075</msdn-id>
|
|
<unmanaged>DXGI_SWAP_CHAIN_DESC</unmanaged>
|
|
<unmanaged-short>DXGI_SWAP_CHAIN_DESC</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredBackBufferWidth">
|
|
<summary>
|
|
A value that describes the resolution width.
|
|
</summary>
|
|
<msdn-id>bb173075</msdn-id>
|
|
<unmanaged>DXGI_MODE_DESC BufferDesc</unmanaged>
|
|
<unmanaged-short>DXGI_MODE_DESC BufferDesc</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredBackBufferHeight">
|
|
<summary>
|
|
A value that describes the resolution height.
|
|
</summary>
|
|
<msdn-id>bb173075</msdn-id>
|
|
<unmanaged>DXGI_MODE_DESC BufferDesc</unmanaged>
|
|
<unmanaged-short>DXGI_MODE_DESC BufferDesc</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredBackBufferFormat">
|
|
<summary>
|
|
A <strong><see cref="T:SharpDX.DXGI.Format"/></strong> structure describing the display format.
|
|
</summary>
|
|
<msdn-id>bb173075</msdn-id>
|
|
<unmanaged>DXGI_MODE_DESC BufferDesc</unmanaged>
|
|
<unmanaged-short>DXGI_MODE_DESC BufferDesc</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredDepthStencilFormat">
|
|
<summary>
|
|
Gets or sets the depth stencil format
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.IsFullScreen">
|
|
<summary>
|
|
Gets or sets a value indicating whether the application is in full screen mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredGraphicsProfile">
|
|
<summary>
|
|
Gets or sets the minimum graphics profile.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferMultiSampling">
|
|
<summary>
|
|
Gets or sets a value indicating the number of sample locations during multisampling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GameGraphicsParameters.SynchronizeWithVerticalRetrace">
|
|
<summary>
|
|
Gets or sets a value indicating whether to synochrnize present with vertical blanking.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameWindowWinRT">
|
|
<summary>
|
|
An abstract window.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameWindow">
|
|
<summary>
|
|
An abstract window.
|
|
</summary>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameWindow.ClientBounds">
|
|
<summary>
|
|
Gets the client bounds.
|
|
</summary>
|
|
<value>The client bounds.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameWindow.CurrentOrientation">
|
|
<summary>
|
|
Gets the current orientation.
|
|
</summary>
|
|
<value>The current orientation.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameWindow.IsMinimized">
|
|
<summary>
|
|
Gets a value indicating whether this instance is minimized.
|
|
</summary>
|
|
<value><c>true</c> if this instance is minimized; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameWindow.NativeWindow">
|
|
<summary>
|
|
Gets the native window.
|
|
</summary>
|
|
<value>The native window.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameWindow.Title">
|
|
<summary>
|
|
Gets or sets the title of the window.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.Game">
|
|
<summary>
|
|
The game.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Game"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.Exit">
|
|
<summary>
|
|
Exits the game.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.ResetElapsedTime">
|
|
<summary>
|
|
Resets the elapsed time counter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.Run(System.Object)">
|
|
<summary>
|
|
Call this method to initialize the game, begin running the game loop, and start processing events for the game.
|
|
</summary>
|
|
<param name="windowContext">The window Context.</param>
|
|
<exception cref="T:System.InvalidOperationException">Cannot run this instance while it is already running</exception>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.SuppressDraw">
|
|
<summary>
|
|
Prevents calls to Draw until the next Update.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.Tick">
|
|
<summary>
|
|
Updates the game's clock and calls Update and Draw.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.BeginDraw">
|
|
<summary>
|
|
Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw.
|
|
</summary>
|
|
<returns><c>true</c> to continue drawing, false to not call <see cref="M:SharpDX.Toolkit.Game.Draw(SharpDX.Toolkit.GameTime)"/> and <see cref="M:SharpDX.Toolkit.Game.EndDraw"/></returns>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.BeginRun">
|
|
<summary>
|
|
Called after all components are initialized but before the first update in the game loop.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.Draw(SharpDX.Toolkit.GameTime)">
|
|
<summary>
|
|
Reference page contains code sample.
|
|
</summary>
|
|
<param name="gameTime">
|
|
Time passed since the last call to Draw.
|
|
</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.EndDraw">
|
|
<summary>Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw.</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.EndRun">
|
|
<summary>Called after the game loop has stopped running before exiting.</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.Initialize">
|
|
<summary>Called after the Game and GraphicsDevice are created, but before LoadContent. Reference page contains code sample.</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.LoadContent">
|
|
<summary>
|
|
Loads the content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.OnActivated(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Raises the Activated event. Override this method to add code to handle when the game gains focus.
|
|
</summary>
|
|
<param name="sender">The Game.</param>
|
|
<param name="args">Arguments for the Activated event.</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.OnDeactivated(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Raises the Deactivated event. Override this method to add code to handle when the game loses focus.
|
|
</summary>
|
|
<param name="sender">The Game.</param>
|
|
<param name="args">Arguments for the Deactivated event.</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.OnExiting(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Raises an Exiting event. Override this method to add code to handle when the game is exiting.
|
|
</summary>
|
|
<param name="sender">The Game.</param>
|
|
<param name="args">Arguments for the Exiting event.</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.ShowMissingRequirementMessage(System.Exception)">
|
|
<summary>
|
|
This is used to display an error message if there is no suitable graphics device or sound card.
|
|
</summary>
|
|
<param name="exception">The exception to display.</param>
|
|
<returns>The <see cref="T:System.Boolean"/>.</returns>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.UnloadContent">
|
|
<summary>
|
|
Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.Game.Update(SharpDX.Toolkit.GameTime)">
|
|
<summary>
|
|
Reference page contains links to related conceptual articles.
|
|
</summary>
|
|
<param name="gameTime">
|
|
Time passed since the last call to Update.
|
|
</param>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.Game.Activated">
|
|
<summary>
|
|
Occurs when [activated].
|
|
</summary>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.Game.Deactivated">
|
|
<summary>
|
|
Occurs when [deactivated].
|
|
</summary>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.Game.Exiting">
|
|
<summary>
|
|
Occurs when [exiting].
|
|
</summary>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.Content">
|
|
<summary>
|
|
Gets or sets the <see cref="T:SharpDX.Toolkit.Content.ContentManager"/>.
|
|
</summary>
|
|
<value>The content manager.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.GameSystems">
|
|
<summary>
|
|
Gets the game components registered by this game.
|
|
</summary>
|
|
<value>The game components.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.GraphicsDevice">
|
|
<summary>
|
|
Gets the graphics device.
|
|
</summary>
|
|
<value>The graphics device.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.InactiveSleepTime">
|
|
<summary>
|
|
Gets or sets the inactive sleep time.
|
|
</summary>
|
|
<value>The inactive sleep time.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.IsActive">
|
|
<summary>
|
|
Gets a value indicating whether this instance is active.
|
|
</summary>
|
|
<value><c>true</c> if this instance is active; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.IsFixedTimeStep">
|
|
<summary>
|
|
Gets or sets a value indicating whether this instance is fixed time step.
|
|
</summary>
|
|
<value><c>true</c> if this instance is fixed time step; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.IsMouseVisible">
|
|
<summary>
|
|
Gets or sets a value indicating whether the mouse should be visible.
|
|
</summary>
|
|
<value><c>true</c> if the mouse should be visible; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.LaunchParameters">
|
|
<summary>
|
|
Gets the launch parameters.
|
|
</summary>
|
|
<value>The launch parameters.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.IsRunning">
|
|
<summary>
|
|
Gets a value indicating whether is running.
|
|
</summary>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.Services">
|
|
<summary>
|
|
Gets the service container.
|
|
</summary>
|
|
<value>The service container.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.TargetElapsedTime">
|
|
<summary>
|
|
Gets or sets the target elapsed time.
|
|
</summary>
|
|
<value>The target elapsed time.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.Game.Window">
|
|
<summary>
|
|
Gets the abstract window.
|
|
</summary>
|
|
<value>The window.</value>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.Game.DrawableComparer">
|
|
<summary>
|
|
The comparer used to order <see cref="T:SharpDX.Toolkit.IDrawable"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.Game.UpdateableComparer">
|
|
<summary>
|
|
The comparer used to order <see cref="T:SharpDX.Toolkit.IUpdateable"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameSystem">
|
|
<summary>
|
|
Base class for a <see cref="T:SharpDX.Toolkit.GameSystem"/> component.
|
|
</summary>
|
|
<remarks>
|
|
A <see cref="T:SharpDX.Toolkit.GameSystem"/> component can be used to
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.IGameSystem">
|
|
<summary>
|
|
Defines a generic game system.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IGameSystem.Initialize">
|
|
<summary>
|
|
This method is called when the component is added to the game.
|
|
</summary>
|
|
<remarks>
|
|
This method can be used for tasks like querying for services the component needs and setting up non-graphics resources.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.IUpdateable">
|
|
<summary>
|
|
An interface that is called by <see cref="M:SharpDX.Toolkit.Game.Update(SharpDX.Toolkit.GameTime)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IUpdateable.Update(SharpDX.Toolkit.GameTime)">
|
|
<summary>
|
|
This method is called when this game component is updated.
|
|
</summary>
|
|
<param name="gameTime">The current timing.</param>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.IUpdateable.EnabledChanged">
|
|
<summary>
|
|
Occurs when the <see cref="P:SharpDX.Toolkit.IUpdateable.Enabled"/> property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.IUpdateable.UpdateOrderChanged">
|
|
<summary>
|
|
Occurs when the <see cref="P:SharpDX.Toolkit.IUpdateable.UpdateOrder"/> property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.IUpdateable.Enabled">
|
|
<summary>
|
|
Gets a value indicating whether the game component's Update method should be called by <see cref="M:SharpDX.Toolkit.Game.Update(SharpDX.Toolkit.GameTime)"/>.
|
|
</summary>
|
|
<value><c>true</c> if update is enabled; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.IUpdateable.UpdateOrder">
|
|
<summary>
|
|
Gets the update order relative to other game components. Lower values are updated first.
|
|
</summary>
|
|
<value>The update order.</value>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.IDrawable">
|
|
<summary>
|
|
An interface for a drawable game component that is called by the <see cref="T:SharpDX.Toolkit.Game"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IDrawable.Draw(SharpDX.Toolkit.GameTime)">
|
|
<summary>
|
|
Draws this instance.
|
|
</summary>
|
|
<param name="gameTime">The current timing.</param>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.IDrawable.DrawOrderChanged">
|
|
<summary>
|
|
Occurs when the <see cref="P:SharpDX.Toolkit.IDrawable.DrawOrder"/> property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="E:SharpDX.Toolkit.IDrawable.VisibleChanged">
|
|
<summary>
|
|
Occurs when the <see cref="P:SharpDX.Toolkit.IDrawable.DrawOrder"/> property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.IDrawable.Visible">
|
|
<summary>
|
|
Gets a value indicating whether the <see cref="M:SharpDX.Toolkit.IDrawable.Draw(SharpDX.Toolkit.GameTime)"/> method should be called by <see cref="M:SharpDX.Toolkit.Game.Draw(SharpDX.Toolkit.GameTime)"/>.
|
|
</summary>
|
|
<value><c>true</c> if this drawable component is visible; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.IDrawable.DrawOrder">
|
|
<summary>
|
|
Gets the draw order relative to other objects. <see cref="T:SharpDX.Toolkit.IDrawable"/> objects with a lower value are drawn first.
|
|
</summary>
|
|
<value>The draw order.</value>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameSystem.#ctor(SharpDX.IServiceRegistry)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameSystem"/> class.
|
|
</summary>
|
|
<param name="registry">The registry.</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameSystem.#ctor(SharpDX.Toolkit.Game)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameSystem"/> class.
|
|
</summary>
|
|
<param name="game">The game.</param>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameSystem.Game">
|
|
<summary>
|
|
Gets the <see cref="P:SharpDX.Toolkit.GameSystem.Game"/> associated with this <see cref="T:SharpDX.Toolkit.GameSystem"/>. This value can be null in a mock environment.
|
|
</summary>
|
|
<value>The game.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameSystem.Content">
|
|
<summary>
|
|
Gets the content manager.
|
|
</summary>
|
|
<value>The content.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameSystem.GraphicsDevice">
|
|
<summary>
|
|
Gets the graphics device.
|
|
</summary>
|
|
<value>The graphics device.</value>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameSystemCollection">
|
|
<summary>A collection of game components.</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameServiceRegistry">
|
|
<summary>
|
|
Main service provider for <see cref="T:SharpDX.Toolkit.Game"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameServiceRegistry.GetService(System.Type)">
|
|
<summary>
|
|
Gets the instance service providing a specified service.
|
|
</summary>
|
|
<param name="type">The type of service.</param>
|
|
<returns>The registered instance of this service.</returns>
|
|
<exception cref="T:System.ArgumentNullException">type</exception>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameServiceRegistry.AddService(System.Type,System.Object)">
|
|
<summary>
|
|
Adds a service to this <see cref="T:SharpDX.Toolkit.GameServiceRegistry"/>.
|
|
</summary>
|
|
<param name="type">The type of service to add.</param>
|
|
<param name="provider">The service provider to add.</param>
|
|
<exception cref="T:System.ArgumentNullException">type;Service type cannot be null</exception>
|
|
<exception cref="T:System.ArgumentException">Service is already registered;type</exception>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameServiceRegistry.RemoveService(System.Type)">
|
|
<summary>Removes the object providing a specified service.</summary>
|
|
<param name="type">The type of service.</param>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GameTime">
|
|
<summary>
|
|
Current timing used for variable-step (real time) or fixed-step (game time) games.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameTime.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameTime"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameTime.#ctor(System.TimeSpan,System.TimeSpan)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameTime"/> class.
|
|
</summary>
|
|
<param name="totalGameTime">The total game time since the start of the game.</param>
|
|
<param name="elapsedGameTime">The elapsed game time since the last update.</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GameTime.#ctor(System.TimeSpan,System.TimeSpan,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameTime"/> class.
|
|
</summary>
|
|
<param name="totalGameTime">The total game time since the start of the game.</param>
|
|
<param name="elapsedGameTime">The elapsed game time since the last update.</param>
|
|
<param name="isRunningSlowly">True if the game is running unexpectedly slowly.</param>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameTime.ElapsedGameTime">
|
|
<summary>
|
|
Gets the elapsed game time since the last update
|
|
</summary>
|
|
<value>The elapsed game time.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameTime.IsRunningSlowly">
|
|
<summary>
|
|
Gets a value indicating whether the game is running slowly than its TargetElapsedTime. This can be used for example to render less details...etc.
|
|
</summary>
|
|
<value><c>true</c> if this instance is running slowly; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameTime.TotalGameTime">
|
|
<summary>
|
|
Gets the amount of game time since the start of the game.
|
|
</summary>
|
|
<value>The total game time.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GameTime.FrameCount">
|
|
<summary>
|
|
Gets the current frame count since the start of the game.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.Equals(System.Object)">
|
|
<summary>Returns a value that indicates whether the current instance is equal to a specified object.</summary>
|
|
<param name="obj">The Object to compare with the current GraphicsDeviceInformation.</param>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.GetHashCode">
|
|
<summary>Gets the hash code for this object.</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.Clone">
|
|
<summary>
|
|
Clones this instance.
|
|
</summary>
|
|
<returns>A new copy-instance of this GraphicsDeviceInformation.</returns>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.Adapter">
|
|
<summary>
|
|
Gets or sets the adapter.
|
|
</summary>
|
|
<value>The adapter.</value>
|
|
<exception cref="T:System.ArgumentNullException">if value is null</exception>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.GraphicsProfile">
|
|
<summary>
|
|
Gets or sets the graphics profile.
|
|
</summary>
|
|
<value>The graphics profile.</value>
|
|
<exception cref="T:System.ArgumentNullException">if value is null</exception>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.PresentationParameters">
|
|
<summary>
|
|
Gets or sets the presentation parameters.
|
|
</summary>
|
|
<value>The presentation parameters.</value>
|
|
<exception cref="T:System.ArgumentNullException">if value is null</exception>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.DeviceCreationFlags">
|
|
<summary>
|
|
Gets or sets the creation flags.
|
|
</summary>
|
|
<value>The creation flags.</value>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.GraphicsDeviceManager">
|
|
<summary>
|
|
Manages the <see cref="P:SharpDX.Toolkit.GraphicsDeviceManager.GraphicsDevice"/> lifecycle.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.IGraphicsDeviceManager">
|
|
<summary>
|
|
Defines the interface for an object that manages a GraphicsDevice.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IGraphicsDeviceManager.BeginDraw">
|
|
<summary>
|
|
Starts the drawing of a frame.
|
|
</summary>
|
|
<returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IGraphicsDeviceManager.CreateDevice">
|
|
<summary>
|
|
Called to ensure that the device manager has created a valid device.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.IGraphicsDeviceManager.EndDraw">
|
|
<summary>
|
|
Called by the game at the end of drawing; presents the final rendering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GraphicsDeviceManager.DefaultBackBufferWidth">
|
|
<summary>
|
|
Default width for the back buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.Toolkit.GraphicsDeviceManager.DefaultBackBufferHeight">
|
|
<summary>
|
|
Default height for the back buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.#ctor(SharpDX.Toolkit.Game)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GraphicsDeviceManager"/> class.
|
|
</summary>
|
|
<param name="game">The game.</param>
|
|
<exception cref="T:System.ArgumentNullException">The game instance cannot be null.</exception>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.SetPreferredGraphicsProfile(SharpDX.Direct3D.FeatureLevel[])">
|
|
<summary>
|
|
Sets the preferred graphics profile.
|
|
</summary>
|
|
<param name="levels">The levels.</param>
|
|
<seealso cref="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredGraphicsProfile"/>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.ApplyChanges">
|
|
<summary>
|
|
Applies the changes from this instance and change or create the <see cref="P:SharpDX.Toolkit.GraphicsDeviceManager.GraphicsDevice"/> according to the new values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.CanResetDevice(SharpDX.Toolkit.GraphicsDeviceInformation)">
|
|
<summary>
|
|
Determines whether this instance is compatible with the the specified new <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/>.
|
|
</summary>
|
|
<param name="newDeviceInfo">The new device info.</param>
|
|
<returns><c>true</c> if this instance this instance is compatible with the the specified new <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/>; otherwise, <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.FindBestDevice(System.Boolean)">
|
|
<summary>
|
|
Finds the best device that is compatible with the preferences defined in this instance.
|
|
</summary>
|
|
<param name="anySuitableDevice">if set to <c>true</c> a device can be selected from any existing adapters, otherwise, it will select only from default adapter.</param>
|
|
<returns>The graphics device information.</returns>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.RankDevices(System.Collections.Generic.List{SharpDX.Toolkit.GraphicsDeviceInformation})">
|
|
<summary>
|
|
Ranks a list of <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/> before creating a new device.
|
|
</summary>
|
|
<param name="foundDevices">The list of devices that can be reorder.</param>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredGraphicsProfile">
|
|
<summary>
|
|
Gets or sets the list of graphics profile to select from the best feature to the lower feature. See remarks.
|
|
</summary>
|
|
<value>The graphics profile.</value>
|
|
<remarks>
|
|
By default, the PreferredGraphicsProfile is set to { <see cref="F:SharpDX.Direct3D.FeatureLevel.Level_11_1"/>,
|
|
<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_11_0"/>,
|
|
<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_10_1"/>,
|
|
<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_10_0"/>,
|
|
<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_9_3"/>,
|
|
<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_9_2"/>,
|
|
<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_9_1"/>}
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.IsFullScreen">
|
|
<summary>
|
|
Gets or sets a value indicating whether this instance is full screen.
|
|
</summary>
|
|
<value><c>true</c> if this instance is full screen; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferMultiSampling">
|
|
<summary>
|
|
Gets or sets a value indicating whether [prefer multi sampling].
|
|
</summary>
|
|
<value><c>true</c> if [prefer multi sampling]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.DeviceCreationFlags">
|
|
<summary>
|
|
Gets or sets the device creation flags that will be used to create the <see cref="P:SharpDX.Toolkit.GraphicsDeviceManager.GraphicsDevice"/>
|
|
</summary>
|
|
<value>The device creation flags.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredBackBufferFormat">
|
|
<summary>
|
|
Gets or sets the preferred back buffer format.
|
|
</summary>
|
|
<value>The preferred back buffer format.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredBackBufferHeight">
|
|
<summary>
|
|
Gets or sets the height of the preferred back buffer.
|
|
</summary>
|
|
<value>The height of the preferred back buffer.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredBackBufferWidth">
|
|
<summary>
|
|
Gets or sets the width of the preferred back buffer.
|
|
</summary>
|
|
<value>The width of the preferred back buffer.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredDepthStencilFormat">
|
|
<summary>
|
|
Gets or sets the preferred depth stencil format.
|
|
</summary>
|
|
<value>The preferred depth stencil format.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.SupportedOrientations">
|
|
<summary>
|
|
Gets or sets the supported orientations.
|
|
</summary>
|
|
<value>The supported orientations.</value>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.SynchronizeWithVerticalRetrace">
|
|
<summary>
|
|
Gets or sets a value indicating whether [synchronize with vertical retrace].
|
|
</summary>
|
|
<value><c>true</c> if [synchronize with vertical retrace]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.LaunchParameters">
|
|
<summary>
|
|
Parameters used when launching an application.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.LaunchParameters.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.LaunchParameters"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.NamespaceDoc">
|
|
<summary>
|
|
The <see cref="N:SharpDX.Toolkit"/> namespace provides a high level Game API.
|
|
</summary>
|
|
</member>
|
|
<member name="T:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs">
|
|
<summary>
|
|
Describes settings to apply before preparing a device for creation, used by <see cref="M:SharpDX.Toolkit.GraphicsDeviceManager.OnPreparingDeviceSettings(System.Object,SharpDX.Toolkit.PreparingDeviceSettingsEventArgs)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs.#ctor(SharpDX.Toolkit.GraphicsDeviceInformation)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs"/> class.
|
|
</summary>
|
|
<param name="graphicsDeviceInformation">The graphics device information.</param>
|
|
</member>
|
|
<member name="P:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs.GraphicsDeviceInformation">
|
|
<summary>
|
|
Gets the graphics device information.
|
|
</summary>
|
|
<value>The graphics device information.</value>
|
|
</member>
|
|
</members>
|
|
</doc>
|