Context Navigation

source: branches/HeuristicLab.BinPacking/PackingPlanVisualizations/SharpDX/SharpDX.Toolkit.Game.xml @ 13083

Visit:

Last change on this file since 13083 was 13028, checked in by gkronber, 9 years ago

added PackingPlanVisualizations plugin received from jhelm.
this project also contains necessary binaries of SharpDX
visualization in HL works now

File size: 49.8 KB

Line
1	<?xml version="1.0"?>
2	<doc>
3	<assembly>
4	<name>SharpDX.Toolkit.Game</name>
5	</assembly>
6	<members>
7	<member name="T:SharpDX.Toolkit.AssemblyDoc">
8	<summary>
9	The <see cref="A:SharpDX.Toolkit.Game"/> assembly provides a high level Game API.
10	</summary>
11	</member>
12	<member name="T:SharpDX.Toolkit.EffectCompilerEventArgs">
13	<summary>
14	Describes an event when an effect is recompiled at runtime.
15	</summary>
16	</member>
17	<member name="M:SharpDX.Toolkit.EffectCompilerEventArgs.#ctor(SharpDX.Toolkit.Graphics.Effect,System.Collections.Generic.IList{SharpDX.Toolkit.Diagnostics.LogMessage})">
18	<summary>
19	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.EffectCompilerEventArgs"/> class.
20	</summary>
21	<param name="effect">The effect.</param>
22	<param name="messages">The log messages.</param>
23	</member>
24	<member name="P:SharpDX.Toolkit.EffectCompilerEventArgs.Effect">
25	<summary>
26	Gets the effect.
27	</summary>
28	<value>The effect.</value>
29	</member>
30	<member name="P:SharpDX.Toolkit.EffectCompilerEventArgs.Messages">
31	<summary>
32	Gets compilation messages. See remarks.
33	</summary>
34	<value>The compilation messages.</value>
35	<remarks>
36	This field is only valid
37	</remarks>
38	</member>
39	<member name="T:SharpDX.Toolkit.EffectCompilerSystem">
40	<summary>
41	Allows to dynamically recompile Effects at runtime when original source code changed, without having to recompile the application. See remarks.
42	</summary>
43	<remarks>
44	The effect must have been compiled with tkfxc and option /Re. This features is only available from Windows Desktop and doesn't work
45	on other platforms.
46	</remarks>
47	</member>
48	<member name="T:SharpDX.Toolkit.GameSystem">
49	<summary>
50	Base class for a <see cref="T:SharpDX.Toolkit.GameSystem"/> component.
51	</summary>
52	<remarks>
53	A <see cref="T:SharpDX.Toolkit.GameSystem"/> component can be used to
54	</remarks>
55	</member>
56	<member name="T:SharpDX.Toolkit.IGameSystem">
57	<summary>
58	Defines a generic game system.
59	</summary>
60	</member>
61	<member name="M:SharpDX.Toolkit.IGameSystem.Initialize">
62	<summary>
63	This method is called when the component is added to the game.
64	</summary>
65	<remarks>
66	This method can be used for tasks like querying for services the component needs and setting up non-graphics resources.
67	</remarks>
68	</member>
69	<member name="T:SharpDX.Toolkit.IUpdateable">
70	<summary>
71	An interface that is called by <see cref="M:SharpDX.Toolkit.Game.Update(SharpDX.Toolkit.GameTime)"/>.
72	</summary>
73	</member>
74	<member name="M:SharpDX.Toolkit.IUpdateable.Update(SharpDX.Toolkit.GameTime)">
75	<summary>
76	This method is called when this game component is updated.
77	</summary>
78	<param name="gameTime">The current timing.</param>
79	</member>
80	<member name="E:SharpDX.Toolkit.IUpdateable.EnabledChanged">
81	<summary>
82	Occurs when the <see cref="P:SharpDX.Toolkit.IUpdateable.Enabled"/> property changes.
83	</summary>
84	</member>
85	<member name="E:SharpDX.Toolkit.IUpdateable.UpdateOrderChanged">
86	<summary>
87	Occurs when the <see cref="P:SharpDX.Toolkit.IUpdateable.UpdateOrder"/> property changes.
88	</summary>
89	</member>
90	<member name="P:SharpDX.Toolkit.IUpdateable.Enabled">
91	<summary>
92	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)"/>.
93	</summary>
94	<value><c>true</c> if update is enabled; otherwise, <c>false</c>.</value>
95	</member>
96	<member name="P:SharpDX.Toolkit.IUpdateable.UpdateOrder">
97	<summary>
98	Gets the update order relative to other game components. Lower values are updated first.
99	</summary>
100	<value>The update order.</value>
101	</member>
102	<member name="T:SharpDX.Toolkit.IDrawable">
103	<summary>
104	An interface for a drawable game component that is called by the <see cref="T:SharpDX.Toolkit.Game"/> class.
105	</summary>
106	</member>
107	<member name="M:SharpDX.Toolkit.IDrawable.BeginDraw">
108	<summary>
109	Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw.
110	</summary>
111	<returns><c>true</c> if Draw should occur, <c>false</c> otherwise</returns>
112	</member>
113	<member name="M:SharpDX.Toolkit.IDrawable.Draw(SharpDX.Toolkit.GameTime)">
114	<summary>
115	Draws this instance.
116	</summary>
117	<param name="gameTime">The current timing.</param>
118	</member>
119	<member name="M:SharpDX.Toolkit.IDrawable.EndDraw">
120	<summary>
121	Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw.
122	</summary>
123	</member>
124	<member name="E:SharpDX.Toolkit.IDrawable.DrawOrderChanged">
125	<summary>
126	Occurs when the <see cref="P:SharpDX.Toolkit.IDrawable.DrawOrder"/> property changes.
127	</summary>
128	</member>
129	<member name="E:SharpDX.Toolkit.IDrawable.VisibleChanged">
130	<summary>
131	Occurs when the <see cref="P:SharpDX.Toolkit.IDrawable.Visible"/> property changes.
132	</summary>
133	</member>
134	<member name="P:SharpDX.Toolkit.IDrawable.Visible">
135	<summary>
136	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)"/>.
137	</summary>
138	<value><c>true</c> if this drawable component is visible; otherwise, <c>false</c>.</value>
139	</member>
140	<member name="P:SharpDX.Toolkit.IDrawable.DrawOrder">
141	<summary>
142	Gets the draw order relative to other objects. <see cref="T:SharpDX.Toolkit.IDrawable"/> objects with a lower value are drawn first.
143	</summary>
144	<value>The draw order.</value>
145	</member>
146	<member name="T:SharpDX.Toolkit.IContentable">
147	<summary>
148	An interface to load and unload content.
149	</summary>
150	</member>
151	<member name="M:SharpDX.Toolkit.IContentable.LoadContent">
152	<summary>
153	Loads the content.
154	</summary>
155	</member>
156	<member name="M:SharpDX.Toolkit.IContentable.UnloadContent">
157	<summary>
158	Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources.
159	</summary>
160	</member>
161	<member name="M:SharpDX.Toolkit.GameSystem.#ctor(SharpDX.IServiceRegistry)">
162	<summary>
163	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameSystem"/> class.
164	</summary>
165	<param name="registry">The registry.</param>
166	</member>
167	<member name="M:SharpDX.Toolkit.GameSystem.#ctor(SharpDX.Toolkit.Game)">
168	<summary>
169	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameSystem"/> class.
170	</summary>
171	<param name="game">The game.</param>
172	</member>
173	<member name="P:SharpDX.Toolkit.GameSystem.Game">
174	<summary>
175	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.
176	</summary>
177	<value>The game.</value>
178	</member>
179	<member name="P:SharpDX.Toolkit.GameSystem.Services">
180	<summary>
181	Gets the services registry.
182	</summary>
183	<value>The services registry.</value>
184	</member>
185	<member name="P:SharpDX.Toolkit.GameSystem.Content">
186	<summary>
187	Gets the content manager.
188	</summary>
189	<value>The content.</value>
190	</member>
191	<member name="P:SharpDX.Toolkit.GameSystem.GraphicsDevice">
192	<summary>
193	Gets the graphics device.
194	</summary>
195	<value>The graphics device.</value>
196	</member>
197	<member name="M:SharpDX.Toolkit.EffectCompilerSystem.#ctor(SharpDX.Toolkit.Game)">
198	<summary>
199	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.EffectCompilerSystem"/> class.
200	</summary>
201	<param name="game">The game.</param>
202	</member>
203	<member name="E:SharpDX.Toolkit.EffectCompilerSystem.CompilationEnded">
204	<summary>
205	Occurs when a compilation ended for an effect.
206	</summary>
207	</member>
208	<member name="E:SharpDX.Toolkit.EffectCompilerSystem.CompilationError">
209	<summary>
210	Occurs when a compilation error occured for an effect.
211	</summary>
212	</member>
213	<member name="E:SharpDX.Toolkit.EffectCompilerSystem.CompilationStarted">
214	<summary>
215	Occurs when a compilation started for an effect.
216	</summary>
217	</member>
218	<member name="T:SharpDX.Toolkit.GameContext">
219	<summary>
220	Contains context used to render the game (Control for WinForm, a DrawingSurface for WP8...etc.).
221	</summary>
222	<summary>
223	A <see cref="T:SharpDX.Toolkit.GameContext"/> to use for rendering to an existing WinForm <see cref="F:SharpDX.Toolkit.GameContext.Control"/>.
224	</summary>
225	</member>
226	<member name="F:SharpDX.Toolkit.GameContext.ContextType">
227	<summary>
228	The context type of this instance.
229	</summary>
230	</member>
231	<member name="F:SharpDX.Toolkit.GameContext.RequestedWidth">
232	<summary>
233	The requested width.
234	</summary>
235	</member>
236	<member name="F:SharpDX.Toolkit.GameContext.RequestedHeight">
237	<summary>
238	The requested height.
239	</summary>
240	</member>
241	<member name="M:SharpDX.Toolkit.GameContext.#ctor">
242	<summary>
243	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameContext"/> class with a default <see cref="T:SharpDX.Windows.RenderForm"/>.
244	</summary>
245	</member>
246	<member name="M:SharpDX.Toolkit.GameContext.#ctor(System.Windows.Forms.Control,System.Int32,System.Int32)">
247	<summary>
248	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameContext"/> class.
249	</summary>
250	<param name="control">The control.</param>
251	<param name="requestedWidth">Width of the requested.</param>
252	<param name="requestedHeight">Height of the requested.</param>
253	</member>
254	<member name="F:SharpDX.Toolkit.GameContext.Control">
255	<summary>
256	The control used as a GameWindow context (either an instance of <see cref="T:System.Windows.Forms.Control"/> or <see cref="T:System.Windows.Controls.Control"/>.
257	</summary>
258	</member>
259	<member name="M:SharpDX.Toolkit.GameContext.op_Implicit(System.Windows.Forms.Control)~SharpDX.Toolkit.GameContext">
260	<summary>
261	Performs an implicit conversion from <see cref="F:SharpDX.Toolkit.GameContext.Control"/> to <see cref="T:SharpDX.Toolkit.GameContext"/>.
262	</summary>
263	<param name="control">The control.</param>
264	<returns>The result of the conversion.</returns>
265	</member>
266	<member name="T:SharpDX.Toolkit.GameContextType">
267	<summary>
268	Type of a <see cref="T:SharpDX.Toolkit.GameContext"/>.
269	</summary>
270	</member>
271	<member name="F:SharpDX.Toolkit.GameContextType.Desktop">
272	<summary>
273	Game running on desktop in a form or <see cref="T:System.Windows.Forms.Control"/>.
274	</summary>
275	</member>
276	<member name="F:SharpDX.Toolkit.GameContextType.DesktopWpf">
277	<summary>
278	Game running on desktop in a WPF window through a D3DImage.
279	</summary>
280	</member>
281	<member name="F:SharpDX.Toolkit.GameContextType.WinRT">
282	<summary>
283	Game running on WinRT in a CoreWindow.
284	</summary>
285	</member>
286	<member name="F:SharpDX.Toolkit.GameContextType.WinRTBackgroundXaml">
287	<summary>
288	Game running on WinRT in a SwapChainBackgroundPanel.
289	</summary>
290	</member>
291	<member name="F:SharpDX.Toolkit.GameContextType.WinRTXaml">
292	<summary>
293	Game running on WinRT in a SurfaceImageSource.
294	</summary>
295	</member>
296	<member name="F:SharpDX.Toolkit.GameContextType.WindowsPhoneBackgroundXaml">
297	<summary>
298	Game running on WinRT in a DrawingBackgroundSurface.
299	</summary>
300	</member>
301	<member name="F:SharpDX.Toolkit.GameContextType.WindowsPhoneXaml">
302	<summary>
303	Game running on WinRT in a DrawingSurface.
304	</summary>
305	</member>
306	<member name="T:SharpDX.Toolkit.GameWindowRenderer">
307	<summary>
308	A GameSystem that allows to draw to another window or control. Currently only valid on desktop with Windows.Forms.
309	</summary>
310	</member>
311	<member name="M:SharpDX.Toolkit.GameWindowRenderer.#ctor(SharpDX.IServiceRegistry,SharpDX.Toolkit.GameContext)">
312	<summary>
313	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameWindowRenderer"/> class.
314	</summary>
315	<param name="registry">The registry.</param>
316	<param name="gameContext">The window context.</param>
317	</member>
318	<member name="M:SharpDX.Toolkit.GameWindowRenderer.#ctor(SharpDX.Toolkit.Game,SharpDX.Toolkit.GameContext)">
319	<summary>
320	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameWindowRenderer"/> class.
321	</summary>
322	<param name="game">The game.</param>
323	<param name="gameContext">The window context.</param>
324	</member>
325	<member name="P:SharpDX.Toolkit.GameWindowRenderer.GameContext">
326	<summary>
327	Gets the underlying native window.
328	</summary>
329	<value>The underlying native window.</value>
330	</member>
331	<member name="P:SharpDX.Toolkit.GameWindowRenderer.Window">
332	<summary>
333	Gets the window.
334	</summary>
335	<value>The window.</value>
336	</member>
337	<member name="P:SharpDX.Toolkit.GameWindowRenderer.Presenter">
338	<summary>
339	Gets or sets the presenter.
340	</summary>
341	<value>The presenter.</value>
342	</member>
343	<member name="P:SharpDX.Toolkit.GameWindowRenderer.PreferredBackBufferFormat">
344	<summary>
345	Gets or sets the preferred back buffer format.
346	</summary>
347	<value>The preferred back buffer format.</value>
348	</member>
349	<member name="P:SharpDX.Toolkit.GameWindowRenderer.PreferredBackBufferHeight">
350	<summary>
351	Gets or sets the height of the preferred back buffer.
352	</summary>
353	<value>The height of the preferred back buffer.</value>
354	</member>
355	<member name="P:SharpDX.Toolkit.GameWindowRenderer.PreferredBackBufferWidth">
356	<summary>
357	Gets or sets the width of the preferred back buffer.
358	</summary>
359	<value>The width of the preferred back buffer.</value>
360	</member>
361	<member name="P:SharpDX.Toolkit.GameWindowRenderer.PreferredDepthStencilFormat">
362	<summary>
363	Gets or sets the preferred depth stencil format.
364	</summary>
365	<value>The preferred depth stencil format.</value>
366	</member>
367	<member name="T:SharpDX.Toolkit.IGamePlatform">
368	<summary>
369	Interface for a game platform (OS, machine dependent).
370	</summary>
371	</member>
372	<member name="M:SharpDX.Toolkit.IGamePlatform.CreateWindow(SharpDX.Toolkit.GameContext)">
373	<summary>
374	Creates the a new <see cref="T:SharpDX.Toolkit.GameWindow"/>. See remarks.
375	</summary>
376	<param name="gameContext">The window context. See remarks.</param>
377	<returns>A new game window.</returns>
378	<remarks>
379	This is currently only supported on Windows Desktop. The window context supported on windows is a subclass of System.Windows.Forms.Control (or null and a default RenderForm will be created).
380	</remarks>
381	</member>
382	<member name="P:SharpDX.Toolkit.IGamePlatform.DefaultAppDirectory">
383	<summary>
384	Gets the default app directory.
385	</summary>
386	<value>The default app directory.</value>
387	</member>
388	<member name="P:SharpDX.Toolkit.IGamePlatform.MainWindow">
389	<summary>
390	Gets the main window.
391	</summary>
392	<value>The main window.</value>
393	</member>
394	<member name="T:SharpDX.Toolkit.GameGraphicsParameters">
395	<summary>
396	Describess how data will be displayed to the screen.
397	</summary>
398	<msdn-id>bb173075</msdn-id>
399	<unmanaged>DXGI_SWAP_CHAIN_DESC</unmanaged>
400	<unmanaged-short>DXGI_SWAP_CHAIN_DESC</unmanaged-short>
401	</member>
402	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredBackBufferWidth">
403	<summary>
404	A value that describes the resolution width.
405	</summary>
406	<msdn-id>bb173075</msdn-id>
407	<unmanaged>DXGI_MODE_DESC BufferDesc</unmanaged>
408	<unmanaged-short>DXGI_MODE_DESC BufferDesc</unmanaged-short>
409	</member>
410	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredBackBufferHeight">
411	<summary>
412	A value that describes the resolution height.
413	</summary>
414	<msdn-id>bb173075</msdn-id>
415	<unmanaged>DXGI_MODE_DESC BufferDesc</unmanaged>
416	<unmanaged-short>DXGI_MODE_DESC BufferDesc</unmanaged-short>
417	</member>
418	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredBackBufferFormat">
419	<summary>
420	A <strong><see cref="T:SharpDX.DXGI.Format"/></strong> structure describing the display format.
421	</summary>
422	<msdn-id>bb173075</msdn-id>
423	<unmanaged>DXGI_MODE_DESC BufferDesc</unmanaged>
424	<unmanaged-short>DXGI_MODE_DESC BufferDesc</unmanaged-short>
425	</member>
426	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredDepthStencilFormat">
427	<summary>
428	Gets or sets the depth stencil format
429	</summary>
430	</member>
431	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.IsFullScreen">
432	<summary>
433	Gets or sets a value indicating whether the application is in full screen mode.
434	</summary>
435	</member>
436	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferredGraphicsProfile">
437	<summary>
438	Gets or sets the minimum graphics profile.
439	</summary>
440	</member>
441	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.PreferMultiSampling">
442	<summary>
443	Gets or sets a value indicating the number of sample locations during multisampling.
444	</summary>
445	</member>
446	<member name="F:SharpDX.Toolkit.GameGraphicsParameters.SynchronizeWithVerticalRetrace">
447	<summary>
448	Gets or sets a value indicating whether to synochrnize present with vertical blanking.
449	</summary>
450	</member>
451	<member name="T:SharpDX.Toolkit.GameWindowDesktop">
452	<summary>
453	An abstract window.
454	</summary>
455	</member>
456	<member name="T:SharpDX.Toolkit.GameWindow">
457	<summary>
458	An abstract window.
459	</summary>
460	</member>
461	<member name="M:SharpDX.Toolkit.GameWindow.CanHandle(SharpDX.Toolkit.GameContext)">
462	<summary>
463	Initializes the GameWindow with the specified window context.
464	</summary>
465	<param name="gameContext">The window context.</param>
466	</member>
467	<member name="E:SharpDX.Toolkit.GameWindow.Activated">
468	<summary>
469	Occurs when this window is activated.
470	</summary>
471	</member>
472	<member name="E:SharpDX.Toolkit.GameWindow.ClientSizeChanged">
473	<summary>
474	Occurs, when device client size is changed.
475	</summary>
476	</member>
477	<member name="E:SharpDX.Toolkit.GameWindow.Deactivated">
478	<summary>
479	Occurs when this window is deactivated.
480	</summary>
481	</member>
482	<member name="E:SharpDX.Toolkit.GameWindow.OrientationChanged">
483	<summary>
484	Occurs, when device orientation is changed.
485	</summary>
486	</member>
487	<member name="P:SharpDX.Toolkit.GameWindow.AllowUserResizing">
488	<summary>
489	Gets or sets, user possibility to resize this window.
490	</summary>
491	</member>
492	<member name="P:SharpDX.Toolkit.GameWindow.ClientBounds">
493	<summary>
494	Gets the client bounds.
495	</summary>
496	<value>The client bounds.</value>
497	</member>
498	<member name="P:SharpDX.Toolkit.GameWindow.CurrentOrientation">
499	<summary>
500	Gets the current orientation.
501	</summary>
502	<value>The current orientation.</value>
503	</member>
504	<member name="P:SharpDX.Toolkit.GameWindow.IsMinimized">
505	<summary>
506	Gets a value indicating whether this instance is minimized.
507	</summary>
508	<value><c>true</c> if this instance is minimized; otherwise, <c>false</c>.</value>
509	</member>
510	<member name="P:SharpDX.Toolkit.GameWindow.IsMouseVisible">
511	<summary>
512	Gets or sets a value indicating whether the mouse pointer is visible over this window.
513	</summary>
514	<value><c>true</c> if this instance is mouse visible; otherwise, <c>false</c>.</value>
515	</member>
516	<member name="P:SharpDX.Toolkit.GameWindow.NativeWindow">
517	<summary>
518	Gets the native window.
519	</summary>
520	<value>The native window.</value>
521	</member>
522	<member name="P:SharpDX.Toolkit.GameWindow.Visible">
523	<summary>
524	Gets or sets a value indicating whether this <see cref="T:SharpDX.Toolkit.GameWindow"/> is visible.
525	</summary>
526	<value><c>true</c> if visible; otherwise, <c>false</c>.</value>
527	</member>
528	<member name="P:SharpDX.Toolkit.GameWindow.Title">
529	<summary>
530	Gets or sets the title of the window.
531	</summary>
532	</member>
533	<member name="P:SharpDX.Toolkit.GameWindowDesktop.Visible">
534	<summary>
535	Gets or sets a value indicating whether this <see cref="T:SharpDX.Toolkit.GameWindow"/> is visible.
536	</summary>
537	<value><c>true</c> if visible; otherwise, <c>false</c>.</value>
538	</member>
539	<member name="T:SharpDX.Toolkit.Game">
540	<summary>
541	The game.
542	</summary>
543	</member>
544	<member name="M:SharpDX.Toolkit.Game.#ctor">
545	<summary>
546	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.Game"/> class.
547	</summary>
548	</member>
549	<member name="M:SharpDX.Toolkit.Game.Exit">
550	<summary>
551	Exits the game.
552	</summary>
553	</member>
554	<member name="M:SharpDX.Toolkit.Game.ResetElapsedTime">
555	<summary>
556	Resets the elapsed time counter.
557	</summary>
558	</member>
559	<member name="M:SharpDX.Toolkit.Game.Run(SharpDX.Toolkit.GameContext)">
560	<summary>
561	Call this method to initialize the game, begin running the game loop, and start processing events for the game.
562	</summary>
563	<param name="gameContext">The window Context for this game.</param>
564	<exception cref="T:System.InvalidOperationException">Cannot run this instance while it is already running</exception>
565	</member>
566	<member name="M:SharpDX.Toolkit.Game.SuppressDraw">
567	<summary>
568	Prevents calls to Draw until the next Update.
569	</summary>
570	</member>
571	<member name="M:SharpDX.Toolkit.Game.Tick">
572	<summary>
573	Updates the game's clock and calls Update and Draw.
574	</summary>
575	</member>
576	<member name="M:SharpDX.Toolkit.Game.BeginDraw">
577	<summary>
578	Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw.
579	</summary>
580	<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>
581	</member>
582	<member name="M:SharpDX.Toolkit.Game.BeginRun">
583	<summary>
584	Called after all components are initialized but before the first update in the game loop.
585	</summary>
586	</member>
587	<member name="M:SharpDX.Toolkit.Game.Draw(SharpDX.Toolkit.GameTime)">
588	<summary>
589	Reference page contains code sample.
590	</summary>
591	<param name="gameTime">
592	Time passed since the last call to Draw.
593	</param>
594	</member>
595	<member name="M:SharpDX.Toolkit.Game.EndDraw">
596	<summary>Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw.</summary>
597	</member>
598	<member name="M:SharpDX.Toolkit.Game.EndRun">
599	<summary>Called after the game loop has stopped running before exiting.</summary>
600	</member>
601	<member name="M:SharpDX.Toolkit.Game.Initialize">
602	<summary>Called after the Game and GraphicsDevice are created, but before LoadContent. Reference page contains code sample.</summary>
603	</member>
604	<member name="M:SharpDX.Toolkit.Game.ToDisposeContent``1(``0)">
605	<summary>
606	Adds an object to be disposed automatically when <see cref="M:SharpDX.Toolkit.Game.UnloadContent"/> is called. See remarks.
607	</summary>
608	<typeparam name="T">Type of the object to dispose</typeparam>
609	<param name="disposable">The disposable object.</param>
610	<returns>The disposable object.</returns>
611	<remarks>
612	Use this method for any content that is not loaded through the <see cref="T:SharpDX.Toolkit.Content.ContentManager"/>.
613	</remarks>
614	</member>
615	<member name="M:SharpDX.Toolkit.Game.LoadContent">
616	<summary>
617	Loads the content.
618	</summary>
619	</member>
620	<member name="M:SharpDX.Toolkit.Game.OnActivated(System.Object,System.EventArgs)">
621	<summary>
622	Raises the Activated event. Override this method to add code to handle when the game gains focus.
623	</summary>
624	<param name="sender">The Game.</param>
625	<param name="args">Arguments for the Activated event.</param>
626	</member>
627	<member name="M:SharpDX.Toolkit.Game.OnDeactivated(System.Object,System.EventArgs)">
628	<summary>
629	Raises the Deactivated event. Override this method to add code to handle when the game loses focus.
630	</summary>
631	<param name="sender">The Game.</param>
632	<param name="args">Arguments for the Deactivated event.</param>
633	</member>
634	<member name="M:SharpDX.Toolkit.Game.OnExiting(System.Object,System.EventArgs)">
635	<summary>
636	Raises an Exiting event. Override this method to add code to handle when the game is exiting.
637	</summary>
638	<param name="sender">The Game.</param>
639	<param name="args">Arguments for the Exiting event.</param>
640	</member>
641	<member name="M:SharpDX.Toolkit.Game.ShowMissingRequirementMessage(System.Exception)">
642	<summary>
643	This is used to display an error message if there is no suitable graphics device or sound card.
644	</summary>
645	<param name="exception">The exception to display.</param>
646	<returns>The <see cref="T:System.Boolean"/>.</returns>
647	</member>
648	<member name="M:SharpDX.Toolkit.Game.UnloadContent">
649	<summary>
650	Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources.
651	</summary>
652	</member>
653	<member name="M:SharpDX.Toolkit.Game.Update(SharpDX.Toolkit.GameTime)">
654	<summary>
655	Reference page contains links to related conceptual articles.
656	</summary>
657	<param name="gameTime">
658	Time passed since the last call to Update.
659	</param>
660	</member>
661	<member name="E:SharpDX.Toolkit.Game.Activated">
662	<summary>
663	Occurs when [activated].
664	</summary>
665	</member>
666	<member name="E:SharpDX.Toolkit.Game.Deactivated">
667	<summary>
668	Occurs when [deactivated].
669	</summary>
670	</member>
671	<member name="E:SharpDX.Toolkit.Game.Exiting">
672	<summary>
673	Occurs when [exiting].
674	</summary>
675	</member>
676	<member name="E:SharpDX.Toolkit.Game.WindowCreated">
677	<summary>
678	Occurs when [window created].
679	</summary>
680	</member>
681	<member name="P:SharpDX.Toolkit.Game.Content">
682	<summary>
683	Gets or sets the <see cref="T:SharpDX.Toolkit.Content.ContentManager"/>.
684	</summary>
685	<value>The content manager.</value>
686	</member>
687	<member name="P:SharpDX.Toolkit.Game.GameSystems">
688	<summary>
689	Gets the game components registered by this game.
690	</summary>
691	<value>The game components.</value>
692	</member>
693	<member name="P:SharpDX.Toolkit.Game.GraphicsDevice">
694	<summary>
695	Gets the graphics device.
696	</summary>
697	<value>The graphics device.</value>
698	</member>
699	<member name="P:SharpDX.Toolkit.Game.InactiveSleepTime">
700	<summary>
701	Gets or sets the inactive sleep time.
702	</summary>
703	<value>The inactive sleep time.</value>
704	</member>
705	<member name="P:SharpDX.Toolkit.Game.IsActive">
706	<summary>
707	Gets a value indicating whether this instance is active.
708	</summary>
709	<value><c>true</c> if this instance is active; otherwise, <c>false</c>.</value>
710	</member>
711	<member name="P:SharpDX.Toolkit.Game.IsFixedTimeStep">
712	<summary>
713	Gets or sets a value indicating whether this instance is fixed time step.
714	</summary>
715	<value><c>true</c> if this instance is fixed time step; otherwise, <c>false</c>.</value>
716	</member>
717	<member name="P:SharpDX.Toolkit.Game.IsMouseVisible">
718	<summary>
719	Gets or sets a value indicating whether the mouse should be visible.
720	</summary>
721	<value><c>true</c> if the mouse should be visible; otherwise, <c>false</c>.</value>
722	</member>
723	<member name="P:SharpDX.Toolkit.Game.LaunchParameters">
724	<summary>
725	Gets the launch parameters.
726	</summary>
727	<value>The launch parameters.</value>
728	</member>
729	<member name="P:SharpDX.Toolkit.Game.IsRunning">
730	<summary>
731	Gets a value indicating whether is running.
732	</summary>
733	</member>
734	<member name="P:SharpDX.Toolkit.Game.Services">
735	<summary>
736	Gets the service container.
737	</summary>
738	<value>The service container.</value>
739	</member>
740	<member name="P:SharpDX.Toolkit.Game.TargetElapsedTime">
741	<summary>
742	Gets or sets the target elapsed time.
743	</summary>
744	<value>The target elapsed time.</value>
745	</member>
746	<member name="P:SharpDX.Toolkit.Game.Window">
747	<summary>
748	Gets the abstract window.
749	</summary>
750	<value>The window.</value>
751	</member>
752	<member name="T:SharpDX.Toolkit.Game.DrawableComparer">
753	<summary>
754	The comparer used to order <see cref="T:SharpDX.Toolkit.IDrawable"/> objects.
755	</summary>
756	</member>
757	<member name="T:SharpDX.Toolkit.Game.UpdateableComparer">
758	<summary>
759	The comparer used to order <see cref="T:SharpDX.Toolkit.IUpdateable"/> objects.
760	</summary>
761	</member>
762	<member name="T:SharpDX.Toolkit.GameSystemCollection">
763	<summary>A collection of game components.</summary>
764	</member>
765	<member name="T:SharpDX.Toolkit.GameServiceRegistry">
766	<summary>
767	Main service provider for <see cref="T:SharpDX.Toolkit.Game"/>.
768	</summary>
769	</member>
770	<member name="M:SharpDX.Toolkit.GameServiceRegistry.GetService(System.Type)">
771	<summary>
772	Gets the instance service providing a specified service.
773	</summary>
774	<param name="type">The type of service.</param>
775	<returns>The registered instance of this service.</returns>
776	<exception cref="T:System.ArgumentNullException">type</exception>
777	</member>
778	<member name="M:SharpDX.Toolkit.GameServiceRegistry.AddService(System.Type,System.Object)">
779	<summary>
780	Adds a service to this <see cref="T:SharpDX.Toolkit.GameServiceRegistry"/>.
781	</summary>
782	<param name="type">The type of service to add.</param>
783	<param name="provider">The service provider to add.</param>
784	<exception cref="T:System.ArgumentNullException">type;Service type cannot be null</exception>
785	<exception cref="T:System.ArgumentException">Service is already registered;type</exception>
786	</member>
787	<member name="M:SharpDX.Toolkit.GameServiceRegistry.RemoveService(System.Type)">
788	<summary>Removes the object providing a specified service.</summary>
789	<param name="type">The type of service.</param>
790	</member>
791	<member name="T:SharpDX.Toolkit.GameTime">
792	<summary>
793	Current timing used for variable-step (real time) or fixed-step (game time) games.
794	</summary>
795	</member>
796	<member name="M:SharpDX.Toolkit.GameTime.#ctor">
797	<summary>
798	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameTime"/> class.
799	</summary>
800	</member>
801	<member name="M:SharpDX.Toolkit.GameTime.#ctor(System.TimeSpan,System.TimeSpan)">
802	<summary>
803	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameTime"/> class.
804	</summary>
805	<param name="totalGameTime">The total game time since the start of the game.</param>
806	<param name="elapsedGameTime">The elapsed game time since the last update.</param>
807	</member>
808	<member name="M:SharpDX.Toolkit.GameTime.#ctor(System.TimeSpan,System.TimeSpan,System.Boolean)">
809	<summary>
810	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GameTime"/> class.
811	</summary>
812	<param name="totalGameTime">The total game time since the start of the game.</param>
813	<param name="elapsedGameTime">The elapsed game time since the last update.</param>
814	<param name="isRunningSlowly">True if the game is running unexpectedly slowly.</param>
815	</member>
816	<member name="P:SharpDX.Toolkit.GameTime.ElapsedGameTime">
817	<summary>
818	Gets the elapsed game time since the last update
819	</summary>
820	<value>The elapsed game time.</value>
821	</member>
822	<member name="P:SharpDX.Toolkit.GameTime.IsRunningSlowly">
823	<summary>
824	Gets a value indicating whether the game is running slowly than its TargetElapsedTime. This can be used for example to render less details...etc.
825	</summary>
826	<value><c>true</c> if this instance is running slowly; otherwise, <c>false</c>.</value>
827	</member>
828	<member name="P:SharpDX.Toolkit.GameTime.TotalGameTime">
829	<summary>
830	Gets the amount of game time since the start of the game.
831	</summary>
832	<value>The total game time.</value>
833	</member>
834	<member name="P:SharpDX.Toolkit.GameTime.FrameCount">
835	<summary>
836	Gets the current frame count since the start of the game.
837	</summary>
838	</member>
839	<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.#ctor">
840	<summary>
841	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/> class.
842	</summary>
843	</member>
844	<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.Equals(System.Object)">
845	<summary>Returns a value that indicates whether the current instance is equal to a specified object.</summary>
846	<param name="obj">The Object to compare with the current GraphicsDeviceInformation.</param>
847	</member>
848	<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.GetHashCode">
849	<summary>Gets the hash code for this object.</summary>
850	</member>
851	<member name="M:SharpDX.Toolkit.GraphicsDeviceInformation.Clone">
852	<summary>
853	Clones this instance.
854	</summary>
855	<returns>A new copy-instance of this GraphicsDeviceInformation.</returns>
856	</member>
857	<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.Adapter">
858	<summary>
859	Gets or sets the adapter.
860	</summary>
861	<value>The adapter.</value>
862	<exception cref="T:System.ArgumentNullException">if value is null</exception>
863	</member>
864	<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.GraphicsProfile">
865	<summary>
866	Gets or sets the graphics profile.
867	</summary>
868	<value>The graphics profile.</value>
869	<exception cref="T:System.ArgumentNullException">if value is null</exception>
870	</member>
871	<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.PresentationParameters">
872	<summary>
873	Gets or sets the presentation parameters.
874	</summary>
875	<value>The presentation parameters.</value>
876	<exception cref="T:System.ArgumentNullException">if value is null</exception>
877	</member>
878	<member name="P:SharpDX.Toolkit.GraphicsDeviceInformation.DeviceCreationFlags">
879	<summary>
880	Gets or sets the creation flags.
881	</summary>
882	<value>The creation flags.</value>
883	</member>
884	<member name="T:SharpDX.Toolkit.GraphicsDeviceManager">
885	<summary>
886	Manages the <see cref="P:SharpDX.Toolkit.GraphicsDeviceManager.GraphicsDevice"/> lifecycle.
887	</summary>
888	</member>
889	<member name="T:SharpDX.Toolkit.IGraphicsDeviceManager">
890	<summary>
891	Defines the interface for an object that manages a GraphicsDevice.
892	</summary>
893	</member>
894	<member name="M:SharpDX.Toolkit.IGraphicsDeviceManager.BeginDraw">
895	<summary>
896	Starts the drawing of a frame.
897	</summary>
898	<returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
899	</member>
900	<member name="M:SharpDX.Toolkit.IGraphicsDeviceManager.CreateDevice">
901	<summary>
902	Called to ensure that the device manager has created a valid device.
903	</summary>
904	</member>
905	<member name="M:SharpDX.Toolkit.IGraphicsDeviceManager.EndDraw">
906	<summary>
907	Called by the game at the end of drawing; presents the final rendering.
908	</summary>
909	</member>
910	<member name="F:SharpDX.Toolkit.GraphicsDeviceManager.DefaultBackBufferWidth">
911	<summary>
912	Default width for the back buffer.
913	</summary>
914	</member>
915	<member name="F:SharpDX.Toolkit.GraphicsDeviceManager.DefaultBackBufferHeight">
916	<summary>
917	Default height for the back buffer.
918	</summary>
919	</member>
920	<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.#ctor(SharpDX.Toolkit.Game)">
921	<summary>
922	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.GraphicsDeviceManager"/> class.
923	</summary>
924	<param name="game">The game.</param>
925	<exception cref="T:System.ArgumentNullException">The game instance cannot be null.</exception>
926	</member>
927	<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.SetPreferredGraphicsProfile(SharpDX.Direct3D.FeatureLevel[])">
928	<summary>
929	Sets the preferred graphics profile.
930	</summary>
931	<param name="levels">The levels.</param>
932	<seealso cref="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredGraphicsProfile"/>
933	</member>
934	<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.ApplyChanges">
935	<summary>
936	Applies the changes from this instance and change or create the <see cref="P:SharpDX.Toolkit.GraphicsDeviceManager.GraphicsDevice"/> according to the new values.
937	</summary>
938	</member>
939	<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.CanResetDevice(SharpDX.Toolkit.GraphicsDeviceInformation)">
940	<summary>
941	Determines whether this instance is compatible with the the specified new <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/>.
942	</summary>
943	<param name="newDeviceInfo">The new device info.</param>
944	<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>
945	</member>
946	<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.FindBestDevice(System.Boolean)">
947	<summary>
948	Finds the best device that is compatible with the preferences defined in this instance.
949	</summary>
950	<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>
951	<returns>The graphics device information.</returns>
952	</member>
953	<member name="M:SharpDX.Toolkit.GraphicsDeviceManager.RankDevices(System.Collections.Generic.List{SharpDX.Toolkit.GraphicsDeviceInformation})">
954	<summary>
955	Ranks a list of <see cref="T:SharpDX.Toolkit.GraphicsDeviceInformation"/> before creating a new device.
956	</summary>
957	<param name="foundDevices">The list of devices that can be reorder.</param>
958	</member>
959	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredGraphicsProfile">
960	<summary>
961	Gets or sets the list of graphics profile to select from the best feature to the lower feature. See remarks.
962	</summary>
963	<value>The graphics profile.</value>
964	<remarks>
965	By default, the PreferredGraphicsProfile is set to { <see cref="!:FeatureLevel.Level_11_1"/>,
966	<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_11_0"/>,
967	<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_10_1"/>,
968	<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_10_0"/>,
969	<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_9_3"/>,
970	<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_9_2"/>,
971	<see cref="F:SharpDX.Direct3D.FeatureLevel.Level_9_1"/>}
972	</remarks>
973	</member>
974	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.IsFullScreen">
975	<summary>
976	Gets or sets a value indicating whether this instance is full screen.
977	</summary>
978	<value><c>true</c> if this instance is full screen; otherwise, <c>false</c>.</value>
979	</member>
980	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferMultiSampling">
981	<summary>
982	Gets or sets a value indicating whether [prefer multi sampling].
983	</summary>
984	<value><c>true</c> if [prefer multi sampling]; otherwise, <c>false</c>.</value>
985	</member>
986	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.DeviceCreationFlags">
987	<summary>
988	Gets or sets the device creation flags that will be used to create the <see cref="P:SharpDX.Toolkit.GraphicsDeviceManager.GraphicsDevice"/>
989	</summary>
990	<value>The device creation flags.</value>
991	</member>
992	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredBackBufferFormat">
993	<summary>
994	Gets or sets the preferred back buffer format.
995	</summary>
996	<value>The preferred back buffer format.</value>
997	</member>
998	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredBackBufferHeight">
999	<summary>
1000	Gets or sets the height of the preferred back buffer.
1001	</summary>
1002	<value>The height of the preferred back buffer.</value>
1003	</member>
1004	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredBackBufferWidth">
1005	<summary>
1006	Gets or sets the width of the preferred back buffer.
1007	</summary>
1008	<value>The width of the preferred back buffer.</value>
1009	</member>
1010	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.PreferredDepthStencilFormat">
1011	<summary>
1012	Gets or sets the preferred depth stencil format.
1013	</summary>
1014	<value>The preferred depth stencil format.</value>
1015	</member>
1016	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.SupportedOrientations">
1017	<summary>
1018	Gets or sets the supported orientations.
1019	</summary>
1020	<value>The supported orientations.</value>
1021	</member>
1022	<member name="P:SharpDX.Toolkit.GraphicsDeviceManager.SynchronizeWithVerticalRetrace">
1023	<summary>
1024	Gets or sets a value indicating whether [synchronize with vertical retrace].
1025	</summary>
1026	<value><c>true</c> if [synchronize with vertical retrace]; otherwise, <c>false</c>.</value>
1027	</member>
1028	<member name="T:SharpDX.Toolkit.LaunchParameters">
1029	<summary>
1030	Parameters used when launching an application.
1031	</summary>
1032	</member>
1033	<member name="M:SharpDX.Toolkit.LaunchParameters.#ctor">
1034	<summary>
1035	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.LaunchParameters"/> class.
1036	</summary>
1037	</member>
1038	<member name="T:SharpDX.Toolkit.NamespaceDoc">
1039	<summary>
1040	The <see cref="N:SharpDX.Toolkit"/> namespace provides a high level Game API.
1041	</summary>
1042	</member>
1043	<member name="T:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs">
1044	<summary>
1045	Describes settings to apply before preparing a device for creation, used by <see cref="M:SharpDX.Toolkit.GraphicsDeviceManager.OnPreparingDeviceSettings(System.Object,SharpDX.Toolkit.PreparingDeviceSettingsEventArgs)"/>.
1046	</summary>
1047	</member>
1048	<member name="M:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs.#ctor(SharpDX.Toolkit.GraphicsDeviceInformation)">
1049	<summary>
1050	Initializes a new instance of the <see cref="T:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs"/> class.
1051	</summary>
1052	<param name="graphicsDeviceInformation">The graphics device information.</param>
1053	</member>
1054	<member name="P:SharpDX.Toolkit.PreparingDeviceSettingsEventArgs.GraphicsDeviceInformation">
1055	<summary>
1056	Gets the graphics device information.
1057	</summary>
1058	<value>The graphics device information.</value>
1059	</member>
1060	</members>
1061	</doc>

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Update cookies preferences