PageRenderTime 314ms CodeModel.GetById 103ms app.highlight 16ms RepoModel.GetById 85ms app.codeStats 1ms

/Dlls/Delta.Platforms.Windows.xml

#
XML | 989 lines | 989 code | 0 blank | 0 comment | 0 complexity | 96362f068251551f0da5b2e4a33800d1 MD5 | raw file

Large files files are truncated, but you can click here to view the full file

  1<?xml version="1.0" encoding="utf-8"?>
  2<doc>
  3  <assembly>
  4    <name>Delta.Platforms.Windows</name>
  5  </assembly>
  6  <members>
  7    <member name="T:Delta.Platforms.Windows.WindowWPF">
  8      <summary>
  9            Window class for all platforms that support WPF (System.Windows)
 10            Reference of the .NET WPF window:
 11            http://msdn.microsoft.com/de-de/library/ms748948.aspx
 12            </summary>
 13    </member>
 14    <member name="M:Delta.Platforms.Windows.WindowWPF.GetDefaultPlayerName">
 15      <summary>
 16            Get default player name from windows identity, and if this fails use
 17            computer name! Usually just used in DeltaLauncher and some tools.
 18            </summary>
 19    </member>
 20    <member name="M:Delta.Platforms.Windows.WindowWPF.#ctor(System.Windows.Window)">
 21      <summary>
 22            Create window with given WPF-Windows, this constructor is
 23            usually used for editors where we want to render into custom
 24            panels. For games we usually just use the empty constructor!
 25            As always, use the Factory to create this class!
 26            </summary>
 27      <param name="setNativeWindow">
 28            Native System.Windows.Window handle for this WPF window.
 29            </param>
 30    </member>
 31    <member name="M:Delta.Platforms.Windows.WindowWPF.Close">
 32      <summary>
 33            Closes the window. This is just one line of code (if at all), but
 34            it uses native data, which we have no access from Application.
 35            </summary>
 36    </member>
 37    <member name="M:Delta.Platforms.Windows.WindowWPF.HandlePlatformEvents">
 38      <summary>
 39            Handles all (native) platform events which waiting in the queue of the
 40            operating system. We don't use this much, maybe for Close, but most
 41            other events (like resizing) are already handled elsewhere.
 42            </summary>
 43    </member>
 44    <member name="M:Delta.Platforms.Windows.WindowWPF.HideCursor">
 45      <summary>
 46            Hide the hardware mouse cursor (use ShowCursor to show it again). This
 47            makes especially sense for fullscreen games or if the game shows its
 48            own mouse cursor. Only used on Windows, other platforms ignore this
 49            (they don't show a hardware mouse cursor anyway).
 50            </summary>
 51    </member>
 52    <member name="M:Delta.Platforms.Windows.WindowWPF.OpenWebsite(System.String)">
 53      <summary>
 54            Open website with the specified url.
 55            </summary>
 56      <param name="url">website url</param>
 57    </member>
 58    <member name="M:Delta.Platforms.Windows.WindowWPF.SetClipboardText(System.String)">
 59      <summary>
 60            Helper method to set clipboard text. Lots of things must be done here
 61            in order for this to work in WPF. We need to create a new STA thread
 62            and we need to handle COMExceptions that can happen when calling
 63            Clipboard.SetText. If all fails the method will log a warning.
 64            </summary>
 65      <param name="text">Text we want to set to the clipboard</param>
 66    </member>
 67    <member name="M:Delta.Platforms.Windows.WindowWPF.Resize(System.Int32,System.Int32)">
 68      <summary>
 69            Resize helper function, will resize this window and set the new width
 70            and height values accordingly. Currently used for unit tests.
 71            </summary>
 72      <param name="newHeight">New Height</param>
 73      <param name="newWidth">New Width</param>
 74    </member>
 75    <member name="M:Delta.Platforms.Windows.WindowWPF.ShowCursor">
 76      <summary>
 77            Show the hardware mouse cursor if it was hidden (see the Hide method).
 78            Please note that this is only useful on Windows because on all other
 79            platforms there won't be any hardware mouse cursor to show anyway.
 80            You can however show your own mouse cursor with lines, sprites or even
 81            in 3D if you like, this method just shows the Windows hardware cursor.
 82            </summary>
 83    </member>
 84    <member name="M:Delta.Platforms.Windows.WindowWPF.ShowErrorDialog(System.String)">
 85      <summary>
 86            Show error dialog, nothing much to say here, will just display a 
 87            windows forms dialog with OK to continue and cancel for aborting the
 88            current app because of the shown error (often unrecoverable anyway).
 89            Note: This will block the app and should only be called for serious
 90            errors that prevent us from continuing or that really need to inform
 91            the user (e.g. Graphic module could not be started).
 92            </summary>
 93      <param name="message">Message to display</param>
 94      <returns>
 95            True if the user pressed yes to ignore, false otherwise.
 96            </returns>
 97    </member>
 98    <member name="M:Delta.Platforms.Windows.WindowWPF.ShowWarningDialog(System.String)">
 99      <summary>
100            Same as ShowError, but just has an OK button to continue and will
101            also output the warning into the log (ShowError is usually called
102            from the Core.Error method anyway and has already log handling).
103            </summary>
104      <param name="message">Message to display</param>
105    </member>
106    <member name="P:Delta.Platforms.Windows.WindowWPF.Handle">
107      <summary>
108            The handle of the window as "anchor" for accessing it on low level
109            logic, e.g. for input module. This is NOT necessary the same handle
110            as ViewportHandle, which is used for rendering. The reason for this
111            is on windows only the top handle for the form gets all the input
112            events, client panels will not get mouse scroll events for example!
113            </summary>
114    </member>
115    <member name="P:Delta.Platforms.Windows.WindowWPF.Title">
116      <summary>
117            The title the window, normally the name of the application.
118            Set in the constructor here, but can also be set to anything else
119            for games, editors or tools (e.g. displaying the current scene name).
120            </summary>
121    </member>
122    <member name="P:Delta.Platforms.Windows.WindowWPF.Icon">
123      <summary>
124            Icon that is shown on the window in windowed mode and in the task bar
125            (for windowed and fullscreen mode). Only used for windows.
126            </summary>
127    </member>
128    <member name="P:Delta.Platforms.Windows.WindowWPF.Location">
129      <summary>
130            Location of this window in desktop coordinates. Rarely used, but some
131            input modules need this for the correct mouse position calculation.
132            Not used if in fullscreen mode and if on a console or mobile platform.
133            </summary>
134    </member>
135    <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportHandle">
136      <summary>
137            The handle of the control where we want to render, this can be the same
138            as the window or an inner control.
139            </summary>
140    </member>
141    <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportOffset">
142      <summary>
143            Represents the relative offset in pixels between the window top-left
144            position and the render surface position. This is often (0, 0),
145            especially on non-windows platforms and on windows too in fullscreen.
146            But if we have a editor form, the render surface might be some panel!
147            </summary>
148    </member>
149    <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportPixelWidth">
150      <summary>
151            The width part of the drawing area size in pixels.
152            </summary>
153    </member>
154    <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportPixelHeight">
155      <summary>
156            The height part of the drawing area size in pixels.
157            </summary>
158    </member>
159    <member name="P:Delta.Platforms.Windows.WindowWPF.IsResizeable">
160      <summary>
161            Is resizeable?
162            </summary>
163    </member>
164    <member name="P:Delta.Platforms.Windows.WindowWPF.IsClosed">
165      <summary>
166            Returns "true" if the windows is closed which means the application can
167            resp. will be quit.
168            </summary>
169    </member>
170    <member name="P:Delta.Platforms.Windows.WindowWPF.IsFocused">
171      <summary>
172            Is focused
173            </summary>
174    </member>
175    <member name="E:Delta.Platforms.Windows.WindowWPF.ResizeEvent">
176      <summary>
177            Resize event we can use to hock some extra code to it, usually just
178            used to update the Screen aspect ratio for the projectionMatrix.
179            </summary>
180    </member>
181    <member name="T:Delta.Platforms.Windows.BitmapFilter">
182      <summary>
183            BitmapFilter class, takes a bitmap in the constructor and will change it
184            with its functions, there are a lot of simple filters, most as powerful
185            as the ones in photoshop. But this filters are only for real-time bitmap
186            manipulation (e.g. we can use an emboss filter for a better locking
187            minimap or an simple static bump map effect), for manipulating static
188            images, use Photoshop (which is far more powerful ^^) The following page
189            helps to explain the filters and provides some of the original code we
190            reused here (thanks and credits fly to Christian Graus for providing this
191            information):
192            http://www.codeproject.com/cs/media/csharpfilters.asp
193            Another nice (newer) source for some bitmap filters can be found at:
194            http://www.codeproject.com/cs/media/Image_Processing_Lab.asp
195            </summary>
196    </member>
197    <member name="M:Delta.Platforms.Windows.BitmapFilter.ScaleDownAndCopyRectGroupPhoto(System.Drawing.Bitmap,System.Int32,System.Int32,System.Boolean)">
198      <summary>
199            Scale down and copy rectangle helper method for Page_Load to scale
200            images down and resize them in the manner that is requested by the url!
201            NOTE: We always keep the aspect ratio, the keepAspectRatio boolean is
202            only used to rescale the newHeight to fit. Else the image will be cutted
203            and we show only the inner center part.
204            </summary>
205      <param name="originalBitmap">Original bitmap</param>
206      <param name="newWidth">New width</param>
207      <param name="newHeight">New height</param>
208      <param name="keepAspectRatioAndChangeWidth">Keep aspect ratio and
209            change width</param>
210      <returns>
211            Resulting bitmap
212            </returns>
213    </member>
214    <member name="M:Delta.Platforms.Windows.BitmapFilter.ScaleDownAndCopyRect(System.Drawing.Bitmap,System.Int32@,System.Int32@,System.Boolean)">
215      <summary>
216            Scale down and copy rectangle
217            </summary>
218      <param name="originalBitmap">Original bitmap</param>
219      <param name="newWidth">New width</param>
220      <param name="newHeight">New height</param>
221      <param name="keepAspectRatioAndChangeHeight">Keep aspect ratio and
222            change height</param>
223      <returns>Resulting image instance.</returns>
224    </member>
225    <member name="M:Delta.Platforms.Windows.BitmapFilter.ScaleDownAndCopyRectNoEffects(System.Drawing.Bitmap,System.Int32,System.Int32,System.Boolean)">
226      <summary>
227            Scale down and copy rectangle helper method for Page_Load to scale
228            images down and resize them in the manner that is requested by the url!
229            NOTE: We always keep the aspect ratio, the keepAspectRatio boolean is
230            only used to rescale the newHeight to fit. Else the image will be cutted
231            and we show only the inner center part.
232            </summary>
233      <param name="originalBitmap">Original bitmap</param>
234      <param name="newWidth">New width</param>
235      <param name="newHeight">New height</param>
236      <param name="keepAspectRatioAndChangeHeight">Keep aspect ratio</param>
237      <returns>
238            Resulting bitmap
239            </returns>
240    </member>
241    <member name="M:Delta.Platforms.Windows.BitmapFilter.CheckIfBorderIsTransparent(System.Drawing.Bitmap,System.Int32,System.Int32,System.Int32,System.Int32)">
242      <summary>
243            Check if border is transparent
244            </summary>
245      <param name="bitmap">The bitmap.</param>
246      <param name="x1">The x1.</param>
247      <param name="y1">The y1.</param>
248      <param name="x2">The x2.</param>
249      <param name="y2">The y2.</param>
250      <returns>True if the border of the image is transparent.</returns>
251    </member>
252    <member name="M:Delta.Platforms.Windows.BitmapFilter.#ctor(System.Drawing.Bitmap)">
253      <summary>
254            Constructor, just sets bitmap we want to change.
255            Use Bitmap (get only) to receive result of any operation!
256            </summary>
257      <param name="setBitmap">Set bitmap.</param>
258    </member>
259    <member name="M:Delta.Platforms.Windows.BitmapFilter.Invert">
260      <summary>
261            Invert whole bitmap graphic, just takes every r, g, b value
262            and invert it (255-oldValue). We manipulate directly the bitmap data!
263            </summary>
264    </member>
265    <member name="M:Delta.Platforms.Windows.BitmapFilter.GrayScale">
266      <summary>
267            Convert bitmap color data to grayscale data, the factors are:
268            red: 0.299, green: 0.587, blue: 0.114
269            </summary>
270    </member>
271    <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustBrightness(System.Int32)">
272      <summary>
273            Adjust brightness, simply add brightnessChange value
274            to each r, g, b value (we will check that resulting value
275            still is in 0-255 range!)
276            </summary>
277      <param name="brightnessChange">The brightness change.</param>
278    </member>
279    <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustContrast(System.Int32)">
280      <summary>
281            Adjust contrast, max. contrastChange is 100 (minimum is -100)
282            </summary>
283      <param name="contrastChange">The contrast change.</param>
284    </member>
285    <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustGamma(System.Single,System.Single,System.Single)">
286      <summary>
287            Adjust gamma of each color component (r, g, b)
288            Values will be bound to 0.2 to 5.0 range!
289            </summary>
290      <param name="redGammaChange">The red gamma change.</param>
291      <param name="greenGammaChange">The green gamma change.</param>
292      <param name="blueGammaChange">The blue gamma change.</param>
293    </member>
294    <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustColor(System.Int32,System.Int32,System.Int32)">
295      <summary>
296            Add color component for each,
297            result values will be bound to 0 to 255.
298            </summary>
299      <param name="redAdd">The red add.</param>
300      <param name="greenAdd">The green add.</param>
301      <param name="blueAdd">The blue add.</param>
302    </member>
303    <member name="M:Delta.Platforms.Windows.BitmapFilter.FadeToColor(System.Byte,System.Byte,System.Byte,System.Single)">
304      <summary>
305            Fade the pixels of the bitmap towards a color over the alpha value.
306            </summary>
307      <param name="alpha">Alpha</param>
308      <param name="blue">Blue</param>
309      <param name="green">Green</param>
310      <param name="red">Red</param>
311    </member>
312    <member name="M:Delta.Platforms.Windows.BitmapFilter.ApplyConvolutionMatrix(Delta.Platforms.Windows.BitmapFilter.ConvolutionMatrix)">
313      <summary>
314            Apply ConvolutionMatrix to bitmap, see description above.
315            For easy use, just use one of the precalculated matrices!
316            </summary>
317      <param name="convMatrix">The conv matrix.</param>
318    </member>
319    <member name="M:Delta.Platforms.Windows.BitmapFilter.Resize(System.Int32,System.Int32,System.Boolean)">
320      <summary>
321            Resize bitmap, cool is use of bilinear filter if needed!
322            </summary>
323      <param name="newWidth">The new width.</param>
324      <param name="newHeight">The new height.</param>
325      <param name="useBilinearFilter">if set to <c>true</c> [use bilinear filter].</param>
326    </member>
327    <member name="M:Delta.Platforms.Windows.BitmapFilter.Resize(System.Drawing.Size,System.Boolean)">
328      <summary>
329            Resize
330            </summary>
331      <param name="newSize">New size</param>
332      <param name="useBilinearFilter">Use bilinear filter</param>
333    </member>
334    <member name="M:Delta.Platforms.Windows.BitmapFilter.ResizeButDontChangeAspectRatio(System.Int32,System.Int32)">
335      <summary>
336            Resize bitmap, but don't change aspect ratio. If image does not fit,
337            we only use a portion of the original image (cutting of the borders).
338            </summary>
339      <param name="newWidth">New width</param>
340      <param name="newHeight">New height</param>
341    </member>
342    <member name="M:Delta.Platforms.Windows.BitmapFilter.ResizeButDontChangeAspectRatioDontCut(System.Int32,System.Int32)">
343      <summary>
344            Resize bitmap, but don't change aspect ratio and do not cut the borders.
345            If image does not fit, fill the rest with white.
346            </summary>
347      <param name="newWidth">New width</param>
348      <param name="newHeight">New height</param>
349    </member>
350    <member name="M:Delta.Platforms.Windows.BitmapFilter.DownsizeHighQuality(System.Int32,System.Int32)">
351      <summary>
352            Resize bitmap, slower than Resize(), but much more quality
353            because we resampling all pixels!
354            Because of the algorithm this will work only properly
355            if sizing down (high resolution bitmap to small bitmap).
356            Very useful to create icons, etc.
357            If new size is bigger, this will look same as Resize
358            without bilinear filter (and will be slower than using Resize)!
359            </summary>
360      <param name="newWidth">The new width.</param>
361      <param name="newHeight">The new height.</param>
362    </member>
363    <member name="M:Delta.Platforms.Windows.BitmapFilter.ConvertTo24Bit">
364      <summary>
365            Helper function to convert any format lower than 24bit
366            up to 24 bit, which is required by most functions here
367            when manipulating pixels!
368            </summary>
369    </member>
370    <member name="M:Delta.Platforms.Windows.BitmapFilter.ConvertTo32Bit">
371      <summary>
372            Helper function to convert any format lower than 32bit to argb 32 bit!
373            </summary>
374    </member>
375    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddWhiteBorders">
376      <summary>
377            Add white borders
378            </summary>
379    </member>
380    <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustContrastAndAddWhiteBorders">
381      <summary>
382            Adjust contrast and add white borders
383            </summary>
384    </member>
385    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
386      <summary>
387            Add bitmap, was filled with lots of error checking and extra bitmap
388            generation before, but that was slow. Now optimized heavily because
389            for most cases (atlas, iphone image generation, website stuff, etc.)
390            we know that bitmapToAdd will usually fit!
391            </summary>
392      <param name="bitmapToAdd">The bitmap to add.</param>
393      <param name="posX">The pos X.</param>
394      <param name="posY">The pos Y.</param>
395    </member>
396    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddTransparentBitmapWithExtraBorder(System.Drawing.Bitmap,System.Int32,System.Int32,System.Boolean,System.Boolean)">
397      <summary>
398            Add bitmap, use pre-multiplied alpha (for all platforms), this avoids
399            white blocks in png graphics usually generated by PhotoShop, and it
400            also simplifies rendering and is the default for many platforms and
401            frameworks nowadays anyway (e.g. XNA). Note: Also added extra border
402            code to help us with UV coordinates and small textures used scaled up.
403            </summary>
404      <param name="bitmapToAdd">The bitmap to add.</param>
405      <param name="posX">The pos X.</param>
406      <param name="posY">The pos Y.</param>
407      <param name="addXBorder">if set to <c>true</c> [add X border].</param>
408      <param name="addYBorder">if set to <c>true</c> [add Y border].</param>
409    </member>
410    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapNoBlending(System.Drawing.Bitmap,System.Int32,System.Int32)">
411      <summary>
412            Add bitmap with no blending, this is pretty much the same method
413            as AddBitmap, but we do not blend alpha with the background, which
414            has unwanted side effects with atlas generation. Instead just copy
415            over the whole image including transparent pixels to make sure the
416            borders of each atlas image look as they should.
417            </summary>
418      <param name="bitmapToAdd">The bitmap to add.</param>
419      <param name="posX">The pos X.</param>
420      <param name="posY">The pos Y.</param>
421    </member>
422    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapVerticalFlip(System.Drawing.Bitmap,System.Int32,System.Int32)">
423      <summary>
424            Helper to add a bitmap on top and vertical flip it while we are at it.
425            </summary>
426      <param name="bitmapToAdd">The bitmap to add.</param>
427      <param name="posX">The pos X.</param>
428      <param name="posY">The pos Y.</param>
429    </member>
430    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapHorizontalFlip(System.Drawing.Bitmap,System.Int32,System.Int32)">
431      <summary>
432            Helper to add a bitmap on top and horizontally flip it.
433            </summary>
434      <param name="bitmapToAdd">The bitmap to add.</param>
435      <param name="posX">The pos X.</param>
436      <param name="posY">The pos Y.</param>
437    </member>
438    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapOnTop(System.Drawing.Bitmap)">
439      <summary>
440            Add bitmap on top
441            </summary>
442      <param name="bitmapToAdd">Bitmap to add</param>
443    </member>
444    <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderBitmapOnTopOfThisTransparentBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
445      <summary>
446            Add bitmap on top
447            </summary>
448      <param name="bitmapToRender">Bitmap to render.</param>
449      <param name="xPos">X position.</param>
450      <param name="yPos">Y position.</param>
451    </member>
452    <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderTransparentBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
453      <summary>
454            Add bitmap on top
455            </summary>
456      <param name="bitmapToRender">Bitmap to render.</param>
457      <param name="xPos">X position.</param>
458      <param name="yPos">Y position.</param>
459    </member>
460    <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderTransparentBitmap(System.Drawing.Bitmap,System.Int32,System.Int32,System.Int32,System.Int32)">
461      <summary>
462            Add bitmap on top
463            </summary>
464      <param name="bitmapToRender">Bitmap to render.</param>
465      <param name="xPos">X position for rendering.</param>
466      <param name="yPos">Y position for rendering.</param>
467      <param name="width">Width of the image.</param>
468      <param name="height">Height of the image.</param>
469    </member>
470    <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
471      <summary>
472            Render bitmap
473            </summary>
474      <param name="bitmapToRender">Bitmap to render.</param>
475      <param name="xPos">X position.</param>
476      <param name="yPos">Y position.</param>
477    </member>
478    <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderClubIcon(System.Drawing.Bitmap,System.Int32,System.Int32)">
479      <summary>
480            Add bitmap on top, very similar to RenderSportIcon, but does not
481            recolor to yellow! White parts of the image are converted to a
482            transparent color.
483            </summary>
484      <param name="bitmapToRender">Bitmap to render.</param>
485      <param name="xPos">X position.</param>
486      <param name="yPos">Y position.</param>
487    </member>
488    <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderSportIcon(System.Drawing.Bitmap,System.Int32,System.Int32)">
489      <summary>
490            Add bitmap on top, makes white transparent and recolors everything
491            to yellow.
492            </summary>
493      <param name="bitmapToRender">Bitmap to render.</param>
494      <param name="xPos">X position for rendering.</param>
495      <param name="yPos">Y position for rendering.</param>
496    </member>
497    <member name="M:Delta.Platforms.Windows.BitmapFilter.MakeBorderTransparent(System.Int32)">
498      <summary>
499            Make border transparent
500            </summary>
501      <param name="pixelsPerBorder">Pixels per border</param>
502    </member>
503    <member name="M:Delta.Platforms.Windows.BitmapFilter.NormalizeNormalMap">
504      <summary>
505            Normalize each pixel/vector of a normal map.
506            </summary>
507    </member>
508    <member name="M:Delta.Platforms.Windows.BitmapFilter.AddOutlineAndShadowPerPixel(System.Boolean,System.Boolean,System.Drawing.Color,System.Drawing.Color)">
509      <summary>
510            Add outline and shadow effects on a pixel basis. Used for font
511            generation because outline glyph drawing on small fonts (size 12 or
512            below) is very blurry and we want sharp pixel fonts for mobile
513            devices.
514            </summary>
515      <param name="addOutline">if set to <c>true</c> [add outline].</param>
516      <param name="addShadow">if set to <c>true</c> [add shadow].</param>
517      <param name="outlineColor">Color of the outline.</param>
518      <param name="shadowColor">Color of the shadow.</param>
519    </member>
520    <member name="P:Delta.Platforms.Windows.BitmapFilter.Bitmap">
521      <summary>
522            Get modified bitmap, setting only allowed in constructor
523            </summary>
524    </member>
525    <member name="T:Delta.Platforms.Windows.BitmapFilter.ConvolutionMatrix">
526      <summary>
527            Helper class for convolution filters!
528            Basically just a 3x3 matrix (or bigger for some filters)
529            with values for each component, there is also a devidor
530            we devide all values through and an additional offset.
531            </summary>
532    </member>
533    <member name="T:Delta.Platforms.Windows.NativeMessageForm">
534      <summary>
535            Native message form
536            </summary>
537    </member>
538    <member name="M:Delta.Platforms.Windows.NativeMessageForm.WndProc(System.Windows.Forms.Message@)">
539      <summary>
540            Native message received.
541            </summary>
542    </member>
543    <member name="E:Delta.Platforms.Windows.NativeMessageForm.NativeEvent">
544      <summary>
545            Native message event.
546            </summary>
547    </member>
548    <member name="T:Delta.Platforms.Windows.WindowsApplication">
549      <summary>
550            Windows implementation for the Application.
551            </summary>
552    </member>
553    <member name="M:Delta.Platforms.Windows.WindowsApplication.SetEditorForm(System.Windows.Forms.Form,System.Windows.Forms.Control)">
554      <summary>
555            Set the specified window and render control for this application.
556            This method is only used for editors or tools which need a different
557            window around a rendering control. Start the Application normally via
558            Application.Start. If you don't call this the engine will create its
559            own window (outside of the editor application, if you want that ^^).
560            </summary>
561      <param name="setWindow">The editors window.</param>
562      <param name="setControl">The control to render into</param>
563    </member>
564    <member name="M:Delta.Platforms.Windows.WindowsApplication.SetEditorWPFWindow(System.Windows.Window,System.Windows.Forms.Integration.WindowsFormsHost)">
565      <summary>
566            Set the specified WPF window and render control for this application.
567            This method is only used for editors or tools which need a different
568            window around a rendering control. Start the Application normally via
569            Application.Start. If you don't call this method for WPF applications
570            the engine will still work and operate normally, but it won't render
571            into the specified WPF control. Instead a new Windows Forms window is
572            created like for normal non-WPF applications.
573            </summary>
574      <param name="setWindow">The editors window.</param>
575      <param name="setHostControl">
576            The WindowsFormsHost control to render into, if it has no children yet,
577            an empty one to render into will be created automatically.
578            </param>
579    </member>
580    <member name="M:Delta.Platforms.Windows.WindowsApplication.MakeSureAppIsNotAlreadyRunning">
581      <summary>
582            Make sure app is not already running. Reference:
583            http://www.codeproject.com/KB/cs/oneprocessonly.aspx
584            Note: Since this is called for many tools first, we also do the
585            ProjectName check here to set the Log.LogName for logging!
586            </summary>
587      <returns>
588            False if we are the only process with our process name. Otherwise true
589            is returned if there are other instances and we need to close our
590            process and stop continuing starting up the engine.
591            </returns>
592    </member>
593    <member name="M:Delta.Platforms.Windows.WindowsApplication.#ctor">
594      <summary>
595            Create a new Windows Application, only allowed via Factory!
596            </summary>
597    </member>
598    <member name="M:Delta.Platforms.Windows.WindowsApplication.Dispose">
599      <summary>
600            After the run loop returns, the we are done executing. Dispose main
601            application modules and do some cleanup here. Dispose is based on the
602            DynamicModule.Dispose, which does kill all the children modules for
603            us automatically in the reverse order they were created and linked up.
604            </summary>
605    </member>
606    <member name="M:Delta.Platforms.Windows.WindowsApplication.StartExecutionLoop">
607      <summary>
608            Start the execution loop. First check for some important stuff like
609            graphics driver or already running instances of the game. If
610            everything is fine we simply use the base method to start the game.
611            </summary>
612    </member>
613    <member name="T:Delta.Platforms.Windows.Window">
614      <summary>
615            Window class for all platforms that support System.Windows.Forms.
616            Unlike most other platform implementations (Xbox, iPhone, etc.) this
617            implementation is quite heavy and powerful, we can handle windowed
618            forms for games and testing, fullscreen mode is usually the default
619            for games on windows and they have even better performance and finally
620            we also support Editors via the EditorForm property, which will use a
621            specific panel for rendering (used in all graphical tools and editors).
622            </summary>
623    </member>
624    <member name="M:Delta.Platforms.Windows.Window.GetDefaultPlayerName">
625      <summary>
626            Get default player name from windows identity, and if this fails use
627            computer name! Usually just used in DeltaLauncher and some tools.
628            </summary>
629      <returns></returns>
630    </member>
631    <member name="M:Delta.Platforms.Windows.Window.#ctor">
632      <summary>
633            Create window by creating a default empty form, which will be
634            filled by the other Window constructor. Only allowed from the Factory!
635            </summary>
636    </member>
637    <member name="M:Delta.Platforms.Windows.Window.#ctor(System.Windows.Forms.Form)">
638      <summary>
639            Create window with given Windows Form, this constructor is
640            usually used for editors where we want to render into custom
641            panels. For games we usually just use the empty constructor!
642            Also only allowed from the Factory!
643            </summary>
644      <param name="setNativeForm">Set native form</param>
645    </member>
646    <member name="M:Delta.Platforms.Windows.Window.Close">
647      <summary>
648            Closes the window. This will get rid of the native form or control,
649            which we can only access here.
650            </summary>
651    </member>
652    <member name="M:Delta.Platforms.Windows.Window.HandlePlatformEvents">
653      <summary>
654            Handles all (native) platform events which waiting in the queue of the
655            operating system. We don't use this much, maybe for Close, but most
656            other events (like resizing) are already handled elsewhere.
657            </summary>
658    </member>
659    <member name="M:Delta.Platforms.Windows.Window.HideCursor">
660      <summary>
661            Hide the hardware mouse cursor (use ShowCursor to show it again). This
662            makes especially sense for fullscreen games or if the game shows its
663            own mouse cursor. Only used on Windows, other platforms ignore this
664            (they don't show a hardware mouse cursor anyway).
665            </summary>
666    </member>
667    <member name="M:Delta.Platforms.Windows.Window.OpenWebsite(System.String)">
668      <summary>
669            Open website with the specified url.
670            </summary>
671      <param name="url">website url</param>
672    </member>
673    <member name="M:Delta.Platforms.Windows.Window.SetClipboardText(System.String)">
674      <summary>
675            Helper method to set clipboard text. We need to create a new STA thread
676            and we need to handle COMExceptions that can happen when calling
677            Clipboard.SetText. If all fails the method will log a warning.
678            </summary>
679      <param name="text">Text we want to set to the clipboard</param>
680    </member>
681    <member name="M:Delta.Platforms.Windows.Window.Resize(System.Int32,System.Int32)">
682      <summary>
683            Resize helper function, will resize this window and set the new width
684            and height values accordingly. Currently used for unit tests.
685            Note: If the viewport size already matches this method does nothing!
686            </summary>
687      <param name="newWidth">The new width.</param>
688      <param name="newHeight">The new height.</param>
689    </member>
690    <member name="M:Delta.Platforms.Windows.Window.ShowCursor">
691      <summary>
692            Show the hardware mouse cursor if it was hidden (see the Hide method).
693            Please note that this is only useful on Windows because on all other
694            platforms there won't be any hardware mouse cursor to show anyway.
695            You can however show your own mouse cursor with lines, sprites or even
696            in 3D if you like, this method just shows the Windows hardware cursor.
697            </summary>
698    </member>
699    <member name="M:Delta.Platforms.Windows.Window.ShowErrorDialog(System.String)">
700      <summary>
701            Show error dialog, nothing much to say here, will just display a
702            windows forms dialog with OK to continue and cancel for aborting the
703            current app because of the shown error (often unrecoverable anyway).
704            Note: This will block the app and should only be called for serious
705            errors that prevent us from continuing or that really need to inform
706            the user (e.g. Graphic module could not be started).
707            </summary>
708      <param name="message">Message to display</param>
709      <returns>
710            True to ignore this error in the future
711            </returns>
712    </member>
713    <member name="M:Delta.Platforms.Windows.Window.ShowWarningDialog(System.String)">
714      <summary>
715            Same as ShowError, but just has an OK button to continue and will
716            also output the warning into the log (ShowError is usually called
717            from the Core.Error method anyway and has already log handling).
718            </summary>
719      <param name="message">Message to display</param>
720    </member>
721    <member name="M:Delta.Platforms.Windows.Window.DesktopToViewport(System.Int32,System.Int32)">
722      <summary>
723            Converts the desktop position of the operating system in the Viewport
724            position.
725            <para /><b>Note:</b> This only used by the WindowsTouch class.
726            </summary>
727      <param name="desktopPositionX">Desktop position x</param>
728      <param name="desktopPositionY">Desktop position y</param>
729      <returns>
730            Point
731            </returns>
732    </member>
733    <member name="P:Delta.Platforms.Windows.Window.NativeForm">
734      <summary>
735            Native form, which holds the native windows form window. This can
736            obviously be a derived class, but you need to cast it back to your
737            type, so do not use this often, cache it somewhere instead!
738            </summary>
739    </member>
740    <member name="P:Delta.Platforms.Windows.Window.Handle">
741      <summary>
742            The handle of the window as "anchor" for accessing it on low level
743            logic, e.g. for input module. This is NOT necessary the same handle
744            as ViewportHandle, which is used for rendering. The reason for this
745            is on windows only the top handle for the form gets all the input
746            events, client panels will not get mouse scroll events for example!
747            </summary>
748    </member>
749    <member name="P:Delta.Platforms.Windows.Window.Title">
750      <summary>
751            The title the window, normally the name of the application.
752            Set in the constructor here, but can also be set to anything else
753            for games, editors or tools (e.g. displaying the current scene name).
754            </summary>
755    </member>
756    <member name="P:Delta.Platforms.Windows.Window.Icon">
757      <summary>
758            Icon that is shown on the window in windowed mode and in the task bar
759            (for windowed and fullscreen mode). Only used for windows.
760            </summary>
761    </member>
762    <member name="P:Delta.Platforms.Windows.Window.Location">
763      <summary>
764            Location of this window in desktop coordinates. Rarely used, but some
765            input modules need this for the correct mouse position calculation.
766            Not used if in fullscreen mode and if on a console or mobile platform.
767            </summary>
768    </member>
769    <member name="P:Delta.Platforms.Windows.Window.ViewportHandle">
770      <summary>
771            The handle of the control where we want to render, this can be the same
772            as the window or an inner control.
773            </summary>
774    </member>
775    <member name="P:Delta.Platforms.Windows.Window.ViewportOffset">
776      <summary>
777            Represents the relative offset in pixels between the window top-left
778            position and the render surface position. This is often (0, 0),
779            especially on non-windows platforms and on windows too in fullscreen.
780            But if we have a editor form, the render surface might be some panel!
781            </summary>
782    </member>
783    <member name="P:Delta.Platforms.Windows.Window.ViewportPixelWidth">
784      <summary>
785            The width part of the drawing area size in pixels.
786            </summary>
787      <value>The width of the viewport in pixel.</value>
788    </member>
789    <member name="P:Delta.Platforms.Windows.Window.ViewportPixelHeight">
790      <summary>
791            The height part of the drawing area size in pixels.
792            </summary>
793      <value>The height of the viewport in pixel.</value>
794    </member>
795    <member name="P:Delta.Platforms.Windows.Window.IsResizable">
796      <summary>
797            Is this window resizable. Useful to disable the ability to resize
798            a windowed mode window application. Will make the maximize box go away
799            and make the borders fixed instead of sizable.
800            </summary>
801      <value>
802        <c>True</c> if this window is resizable; otherwise, <c>false</c>.
803            </value>
804    </member>
805    <member name="P:Delta.Platforms.Windows.Window.IsClosed">
806      <summary>
807            Returns "true" if the windows is closed which means the application can
808            resp. will be quit.
809            </summary>
810      <value>
811        <c>true</c> if this instance is closed; otherwise, <c>false</c>.
812            </value>
813    </member>
814    <member name="P:Delta.Platforms.Windows.Window.IsFocused">
815      <summary>
816            Is focused
817            </summary>
818    </member>
819    <member name="E:Delta.Platforms.Windows.Window.NativeEvent">
820      <summary>
821            Occurs every time if a native message form the Operating System is
822            sended to this window.
823            </summary>
824    </member>
825    <member name="E:Delta.Platforms.Windows.Window.ResizeEvent">
826      <summary>
827            Resize event we can use to hock some extra code to it, usually just
828            used to update the Screen aspect ratio for the projectionMatrix.
829            </summary>
830    </member>
831    <member name="T:Delta.Platforms.Windows.BitmapHelper">
832      <summary>
833            Summary description for BitmapHelper.
834            </summary>
835    </member>
836    <member name="M:Delta.Platforms.Windows.BitmapHelper.GetEncoderInfo(System.String)">
837      <summary>
838            Get encoder info
839            </summary>
840      <param name="mimeType">Mime type</param>
841      <returns>Returns the codec information for the image.</returns>
842    </member>
843    <member name="M:Delta.Platforms.Windows.BitmapHelper.Save(System.Drawing.Bitmap,System.String,System.Drawing.Imaging.ImageFormat)">
844      <summary>
845            Save the bitmap to the specified file path.
846            </summary>
847      <param name="bmp">The Image instance.</param>
848      <param name="name">The path to save the file to.</param>
849      <param name="format">The format the image will be saved as.</param>
850    </member>
851    <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpg(System.Int32,System.Int32,System.String,Delta.Utilities.Datatypes.Color[],System.Boolean)">
852      <summary>
853            Create a bitmap and save it as a jpg. This is only used in the OpenTK
854            screenshot capturer which shouldn't have a reference to System.Drawing.
855            </summary>
856      <param name="width">Width of the image.</param>
857      <param name="height">Height of the image.</param>
858      <param name="name">File name of the image.</param>
859      <param name="pixelData">Pixel color data of the image.</param>
860      <param name="flipY">Should we flip the image horizontally before
861            saving?</param>
862    </member>
863    <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpg(System.Int32,System.Int32,System.String,System.Byte[],System.Boolean)">
864      <summary>
865            Create a bitmap and save it as a jpg. This is only used in the OpenTK
866            screenshot capturer which shouldn't have a reference to System.Drawing.
867            </summary>
868      <param name="width">Width of the image.</param>
869      <param name="height">Height of the image.</param>
870      <param name="name">File name of the image.</param>
871      <param name="rgbData">Pixel color data of the image.</param>
872      <param name="flipY">Should we flip the image horizontally before
873            saving?</param>
874    </member>
875    <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpg(System.Drawing.Bitmap,System.String,System.Int32)">
876      <summary>
877            Save the given bitmap as a Jpg file
878            </summary>
879      <param name="bmp">The Bitmap to be saved</param>
880      <param name="name">The Name of the resulting file</param>
881      <param name="qualityPercent">The desired Quality percent of the
882            resulting Jpg</param>
883    </member>
884    <member name="M:Delta.Platforms.Windows.BitmapHelper.SavePng(System.Drawing.Bitmap,System.String)">
885      <summary>
886            Save png
887            </summary>
888      <param name="bmp">The Bitmap to be saved</param>
889      <param name="name">The Name of the resulting file</param>
890    </member>
891    <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveAsRGBA(System.Drawing.Bitmap,System.String)">
892      <summary>
893            Save as .rgb or .rgba image for OpenGL.
894            </summary>
895      <param name="image">Image data to save out as an .rgba file</param>
896      <param name="rgbaFilepath">Filename with extension for this raw file.
897            Should be either .rgb for RGB 24 bit data or .rgba for 32 bit RGBA.
898            </param>
899    </member>
900    <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpgToStream(System.Drawing.Bitmap,System.IO.Stream,System.Int32)">
901      <summary>
902            Save jpg to stream
903            </summary>
904      <param name="bmp">The Bitmap to be saved</param>
905      <param name="stream">The Stream containing the filepath where the
906            jpg needs to be saved to.</param>
907      <param name="qualityPercent">The desired Quality percent of the
908            resulting Jpg</param>
909    </member>
910    <member name="M:Delta.Platforms.Windows.BitmapHelper.SavePngToStream(System.Drawing.Bitmap,System.IO.Stream)">
911      <summary>
912            Save png to stream
913            </summary>
914      <param name="bmp">The Bitmap to be saved</param>
915      <param name="stream">The Stream containing the file path where the
916            jpg needs to be saved to.</param>
917    </member>
918    <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveBitmap(System.Drawing.Bitmap,System.String,System.Int32)">
919      <summary>
920            Save bitmap (choose jpg file if extension is .jpg, else save as bitmap)
921            </summary>
922      <param name="bmp">The BMP.</param>
923      <param name="name">The name.</param>
924      <param name="qualityPercent">The quality percent.</param>
925    </member>
926    <member name="M:Delta.Platforms.Windows.BitmapHelper.GetCachedBitmapWidth(System.String)">
927      <summary>
928            Get cached bitmap width. Bitmap widths do not change over time, and
929            for example the smilies are ordered by their widths and we need
930            that data over and over again.
931            </summary>
932      <param name="filename">Filename of the bitmap.</param>
933      <returns>Bitmap width stored as an integer.</returns>
934    </member>
935    <member name="M:Delta.Platforms.Windows.BitmapHelper.GetRGBAImageData(System.String,Delta.Utilities.Datatypes.Size@,System.Boolean@)">
936      <summary>
937            Get RGBA image data
938            </summary>
939      <param name="bitmapFilename">The bitmap filename.</param>
940      <param name="size">The size.</param>
941      <param name="hasAlpha">if set to <c>true</c> [has alpha].</param>
942      <returns>RGBA image data (32 bit = 4 byte per pixel)</returns>
943    </member>
944    <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageHasAlpha(System.String)">
945      <summary>
946            Check if a png image has an alpha channel or not.
947            This method is really fast because it only ready the first 26 bytes
948            of the image file.
949            </summary>
950      <param name="filepath">Path to the png file.</param>
951      <returns>True if image has alpha, otherwise false.</returns>
952    </member>
953    <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageHasAlpha(System.IO.Stream)">
954      <summary>
955            Check if a png image has an alpha channel or not.
956            This method is really fast because it only ready the first 26 bytes
957            of the image file.
958            </summary>
959      <param name="inputStream">Png file stream.</param>
960      <returns>True if image has alpha, otherwise false.</returns>
961    </member>
962    <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageUsesAlpha(System.String)">
963      <summary>
964            Check if an image that has an alpha channel is really using it.
965            </summary>
966      <param name="filepath">Path to the png file.</param>
967      <returns>True if image is using alpha, otherwise false.</returns>
968    </member>
969    <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageUsesAlpha(System.Drawing.Bitmap)">
970      <summary>
971            Check if an image that has an alpha channel is really using it.
972            </summary>
973      <param name="filepath">Path to the png file.</param>
974      <returns>True if image is using alpha, otherwise false.</returns>
975    </member>
976    <member name="M:Delta.Platforms.Windows.BitmapHelper.ExpandCanvas(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
977      <summary>
978            Expand the canvas of an image, e.g. place the original image
979            inside a new bigger image.
980            </summary>
981      <param name="filepath">The original image.</param>
982      <param name="expandLeft">Amount of expansion to the left.</param>
983      <param name="expandTop">Amount of expansion to the top.</param>
984      <param name="expandRight">Amount of expansion to the right.</param>
985      <param name="expandBottom">

Large files files are truncated, but you can click here to view the full file