/Dlls/Delta.Platforms.Windows.xml
# · XML · 989 lines · 989 code · 0 blank · 0 comment · 0 complexity · 96362f068251551f0da5b2e4a33800d1 MD5 · raw file
- <?xml version="1.0" encoding="utf-8"?>
- <doc>
- <assembly>
- <name>Delta.Platforms.Windows</name>
- </assembly>
- <members>
- <member name="T:Delta.Platforms.Windows.WindowWPF">
- <summary>
- Window class for all platforms that support WPF (System.Windows)
- Reference of the .NET WPF window:
- http://msdn.microsoft.com/de-de/library/ms748948.aspx
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.GetDefaultPlayerName">
- <summary>
- Get default player name from windows identity, and if this fails use
- computer name! Usually just used in DeltaLauncher and some tools.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.#ctor(System.Windows.Window)">
- <summary>
- Create window with given WPF-Windows, this constructor is
- usually used for editors where we want to render into custom
- panels. For games we usually just use the empty constructor!
- As always, use the Factory to create this class!
- </summary>
- <param name="setNativeWindow">
- Native System.Windows.Window handle for this WPF window.
- </param>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.Close">
- <summary>
- Closes the window. This is just one line of code (if at all), but
- it uses native data, which we have no access from Application.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.HandlePlatformEvents">
- <summary>
- Handles all (native) platform events which waiting in the queue of the
- operating system. We don't use this much, maybe for Close, but most
- other events (like resizing) are already handled elsewhere.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.HideCursor">
- <summary>
- Hide the hardware mouse cursor (use ShowCursor to show it again). This
- makes especially sense for fullscreen games or if the game shows its
- own mouse cursor. Only used on Windows, other platforms ignore this
- (they don't show a hardware mouse cursor anyway).
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.OpenWebsite(System.String)">
- <summary>
- Open website with the specified url.
- </summary>
- <param name="url">website url</param>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.SetClipboardText(System.String)">
- <summary>
- Helper method to set clipboard text. Lots of things must be done here
- in order for this to work in WPF. We need to create a new STA thread
- and we need to handle COMExceptions that can happen when calling
- Clipboard.SetText. If all fails the method will log a warning.
- </summary>
- <param name="text">Text we want to set to the clipboard</param>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.Resize(System.Int32,System.Int32)">
- <summary>
- Resize helper function, will resize this window and set the new width
- and height values accordingly. Currently used for unit tests.
- </summary>
- <param name="newHeight">New Height</param>
- <param name="newWidth">New Width</param>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.ShowCursor">
- <summary>
- Show the hardware mouse cursor if it was hidden (see the Hide method).
- Please note that this is only useful on Windows because on all other
- platforms there won't be any hardware mouse cursor to show anyway.
- You can however show your own mouse cursor with lines, sprites or even
- in 3D if you like, this method just shows the Windows hardware cursor.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.ShowErrorDialog(System.String)">
- <summary>
- Show error dialog, nothing much to say here, will just display a
- windows forms dialog with OK to continue and cancel for aborting the
- current app because of the shown error (often unrecoverable anyway).
- Note: This will block the app and should only be called for serious
- errors that prevent us from continuing or that really need to inform
- the user (e.g. Graphic module could not be started).
- </summary>
- <param name="message">Message to display</param>
- <returns>
- True if the user pressed yes to ignore, false otherwise.
- </returns>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowWPF.ShowWarningDialog(System.String)">
- <summary>
- Same as ShowError, but just has an OK button to continue and will
- also output the warning into the log (ShowError is usually called
- from the Core.Error method anyway and has already log handling).
- </summary>
- <param name="message">Message to display</param>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.Handle">
- <summary>
- The handle of the window as "anchor" for accessing it on low level
- logic, e.g. for input module. This is NOT necessary the same handle
- as ViewportHandle, which is used for rendering. The reason for this
- is on windows only the top handle for the form gets all the input
- events, client panels will not get mouse scroll events for example!
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.Title">
- <summary>
- The title the window, normally the name of the application.
- Set in the constructor here, but can also be set to anything else
- for games, editors or tools (e.g. displaying the current scene name).
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.Icon">
- <summary>
- Icon that is shown on the window in windowed mode and in the task bar
- (for windowed and fullscreen mode). Only used for windows.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.Location">
- <summary>
- Location of this window in desktop coordinates. Rarely used, but some
- input modules need this for the correct mouse position calculation.
- Not used if in fullscreen mode and if on a console or mobile platform.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportHandle">
- <summary>
- The handle of the control where we want to render, this can be the same
- as the window or an inner control.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportOffset">
- <summary>
- Represents the relative offset in pixels between the window top-left
- position and the render surface position. This is often (0, 0),
- especially on non-windows platforms and on windows too in fullscreen.
- But if we have a editor form, the render surface might be some panel!
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportPixelWidth">
- <summary>
- The width part of the drawing area size in pixels.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.ViewportPixelHeight">
- <summary>
- The height part of the drawing area size in pixels.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.IsResizeable">
- <summary>
- Is resizeable?
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.IsClosed">
- <summary>
- Returns "true" if the windows is closed which means the application can
- resp. will be quit.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.WindowWPF.IsFocused">
- <summary>
- Is focused
- </summary>
- </member>
- <member name="E:Delta.Platforms.Windows.WindowWPF.ResizeEvent">
- <summary>
- Resize event we can use to hock some extra code to it, usually just
- used to update the Screen aspect ratio for the projectionMatrix.
- </summary>
- </member>
- <member name="T:Delta.Platforms.Windows.BitmapFilter">
- <summary>
- BitmapFilter class, takes a bitmap in the constructor and will change it
- with its functions, there are a lot of simple filters, most as powerful
- as the ones in photoshop. But this filters are only for real-time bitmap
- manipulation (e.g. we can use an emboss filter for a better locking
- minimap or an simple static bump map effect), for manipulating static
- images, use Photoshop (which is far more powerful ^^) The following page
- helps to explain the filters and provides some of the original code we
- reused here (thanks and credits fly to Christian Graus for providing this
- information):
- http://www.codeproject.com/cs/media/csharpfilters.asp
- Another nice (newer) source for some bitmap filters can be found at:
- http://www.codeproject.com/cs/media/Image_Processing_Lab.asp
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ScaleDownAndCopyRectGroupPhoto(System.Drawing.Bitmap,System.Int32,System.Int32,System.Boolean)">
- <summary>
- Scale down and copy rectangle helper method for Page_Load to scale
- images down and resize them in the manner that is requested by the url!
- NOTE: We always keep the aspect ratio, the keepAspectRatio boolean is
- only used to rescale the newHeight to fit. Else the image will be cutted
- and we show only the inner center part.
- </summary>
- <param name="originalBitmap">Original bitmap</param>
- <param name="newWidth">New width</param>
- <param name="newHeight">New height</param>
- <param name="keepAspectRatioAndChangeWidth">Keep aspect ratio and
- change width</param>
- <returns>
- Resulting bitmap
- </returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ScaleDownAndCopyRect(System.Drawing.Bitmap,System.Int32@,System.Int32@,System.Boolean)">
- <summary>
- Scale down and copy rectangle
- </summary>
- <param name="originalBitmap">Original bitmap</param>
- <param name="newWidth">New width</param>
- <param name="newHeight">New height</param>
- <param name="keepAspectRatioAndChangeHeight">Keep aspect ratio and
- change height</param>
- <returns>Resulting image instance.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ScaleDownAndCopyRectNoEffects(System.Drawing.Bitmap,System.Int32,System.Int32,System.Boolean)">
- <summary>
- Scale down and copy rectangle helper method for Page_Load to scale
- images down and resize them in the manner that is requested by the url!
- NOTE: We always keep the aspect ratio, the keepAspectRatio boolean is
- only used to rescale the newHeight to fit. Else the image will be cutted
- and we show only the inner center part.
- </summary>
- <param name="originalBitmap">Original bitmap</param>
- <param name="newWidth">New width</param>
- <param name="newHeight">New height</param>
- <param name="keepAspectRatioAndChangeHeight">Keep aspect ratio</param>
- <returns>
- Resulting bitmap
- </returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.CheckIfBorderIsTransparent(System.Drawing.Bitmap,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Check if border is transparent
- </summary>
- <param name="bitmap">The bitmap.</param>
- <param name="x1">The x1.</param>
- <param name="y1">The y1.</param>
- <param name="x2">The x2.</param>
- <param name="y2">The y2.</param>
- <returns>True if the border of the image is transparent.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.#ctor(System.Drawing.Bitmap)">
- <summary>
- Constructor, just sets bitmap we want to change.
- Use Bitmap (get only) to receive result of any operation!
- </summary>
- <param name="setBitmap">Set bitmap.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.Invert">
- <summary>
- Invert whole bitmap graphic, just takes every r, g, b value
- and invert it (255-oldValue). We manipulate directly the bitmap data!
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.GrayScale">
- <summary>
- Convert bitmap color data to grayscale data, the factors are:
- red: 0.299, green: 0.587, blue: 0.114
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustBrightness(System.Int32)">
- <summary>
- Adjust brightness, simply add brightnessChange value
- to each r, g, b value (we will check that resulting value
- still is in 0-255 range!)
- </summary>
- <param name="brightnessChange">The brightness change.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustContrast(System.Int32)">
- <summary>
- Adjust contrast, max. contrastChange is 100 (minimum is -100)
- </summary>
- <param name="contrastChange">The contrast change.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustGamma(System.Single,System.Single,System.Single)">
- <summary>
- Adjust gamma of each color component (r, g, b)
- Values will be bound to 0.2 to 5.0 range!
- </summary>
- <param name="redGammaChange">The red gamma change.</param>
- <param name="greenGammaChange">The green gamma change.</param>
- <param name="blueGammaChange">The blue gamma change.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustColor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Add color component for each,
- result values will be bound to 0 to 255.
- </summary>
- <param name="redAdd">The red add.</param>
- <param name="greenAdd">The green add.</param>
- <param name="blueAdd">The blue add.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.FadeToColor(System.Byte,System.Byte,System.Byte,System.Single)">
- <summary>
- Fade the pixels of the bitmap towards a color over the alpha value.
- </summary>
- <param name="alpha">Alpha</param>
- <param name="blue">Blue</param>
- <param name="green">Green</param>
- <param name="red">Red</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ApplyConvolutionMatrix(Delta.Platforms.Windows.BitmapFilter.ConvolutionMatrix)">
- <summary>
- Apply ConvolutionMatrix to bitmap, see description above.
- For easy use, just use one of the precalculated matrices!
- </summary>
- <param name="convMatrix">The conv matrix.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.Resize(System.Int32,System.Int32,System.Boolean)">
- <summary>
- Resize bitmap, cool is use of bilinear filter if needed!
- </summary>
- <param name="newWidth">The new width.</param>
- <param name="newHeight">The new height.</param>
- <param name="useBilinearFilter">if set to <c>true</c> [use bilinear filter].</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.Resize(System.Drawing.Size,System.Boolean)">
- <summary>
- Resize
- </summary>
- <param name="newSize">New size</param>
- <param name="useBilinearFilter">Use bilinear filter</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ResizeButDontChangeAspectRatio(System.Int32,System.Int32)">
- <summary>
- Resize bitmap, but don't change aspect ratio. If image does not fit,
- we only use a portion of the original image (cutting of the borders).
- </summary>
- <param name="newWidth">New width</param>
- <param name="newHeight">New height</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ResizeButDontChangeAspectRatioDontCut(System.Int32,System.Int32)">
- <summary>
- Resize bitmap, but don't change aspect ratio and do not cut the borders.
- If image does not fit, fill the rest with white.
- </summary>
- <param name="newWidth">New width</param>
- <param name="newHeight">New height</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.DownsizeHighQuality(System.Int32,System.Int32)">
- <summary>
- Resize bitmap, slower than Resize(), but much more quality
- because we resampling all pixels!
- Because of the algorithm this will work only properly
- if sizing down (high resolution bitmap to small bitmap).
- Very useful to create icons, etc.
- If new size is bigger, this will look same as Resize
- without bilinear filter (and will be slower than using Resize)!
- </summary>
- <param name="newWidth">The new width.</param>
- <param name="newHeight">The new height.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ConvertTo24Bit">
- <summary>
- Helper function to convert any format lower than 24bit
- up to 24 bit, which is required by most functions here
- when manipulating pixels!
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.ConvertTo32Bit">
- <summary>
- Helper function to convert any format lower than 32bit to argb 32 bit!
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddWhiteBorders">
- <summary>
- Add white borders
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AdjustContrastAndAddWhiteBorders">
- <summary>
- Adjust contrast and add white borders
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Add bitmap, was filled with lots of error checking and extra bitmap
- generation before, but that was slow. Now optimized heavily because
- for most cases (atlas, iphone image generation, website stuff, etc.)
- we know that bitmapToAdd will usually fit!
- </summary>
- <param name="bitmapToAdd">The bitmap to add.</param>
- <param name="posX">The pos X.</param>
- <param name="posY">The pos Y.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddTransparentBitmapWithExtraBorder(System.Drawing.Bitmap,System.Int32,System.Int32,System.Boolean,System.Boolean)">
- <summary>
- Add bitmap, use pre-multiplied alpha (for all platforms), this avoids
- white blocks in png graphics usually generated by PhotoShop, and it
- also simplifies rendering and is the default for many platforms and
- frameworks nowadays anyway (e.g. XNA). Note: Also added extra border
- code to help us with UV coordinates and small textures used scaled up.
- </summary>
- <param name="bitmapToAdd">The bitmap to add.</param>
- <param name="posX">The pos X.</param>
- <param name="posY">The pos Y.</param>
- <param name="addXBorder">if set to <c>true</c> [add X border].</param>
- <param name="addYBorder">if set to <c>true</c> [add Y border].</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapNoBlending(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Add bitmap with no blending, this is pretty much the same method
- as AddBitmap, but we do not blend alpha with the background, which
- has unwanted side effects with atlas generation. Instead just copy
- over the whole image including transparent pixels to make sure the
- borders of each atlas image look as they should.
- </summary>
- <param name="bitmapToAdd">The bitmap to add.</param>
- <param name="posX">The pos X.</param>
- <param name="posY">The pos Y.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapVerticalFlip(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Helper to add a bitmap on top and vertical flip it while we are at it.
- </summary>
- <param name="bitmapToAdd">The bitmap to add.</param>
- <param name="posX">The pos X.</param>
- <param name="posY">The pos Y.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapHorizontalFlip(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Helper to add a bitmap on top and horizontally flip it.
- </summary>
- <param name="bitmapToAdd">The bitmap to add.</param>
- <param name="posX">The pos X.</param>
- <param name="posY">The pos Y.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddBitmapOnTop(System.Drawing.Bitmap)">
- <summary>
- Add bitmap on top
- </summary>
- <param name="bitmapToAdd">Bitmap to add</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderBitmapOnTopOfThisTransparentBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Add bitmap on top
- </summary>
- <param name="bitmapToRender">Bitmap to render.</param>
- <param name="xPos">X position.</param>
- <param name="yPos">Y position.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderTransparentBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Add bitmap on top
- </summary>
- <param name="bitmapToRender">Bitmap to render.</param>
- <param name="xPos">X position.</param>
- <param name="yPos">Y position.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderTransparentBitmap(System.Drawing.Bitmap,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Add bitmap on top
- </summary>
- <param name="bitmapToRender">Bitmap to render.</param>
- <param name="xPos">X position for rendering.</param>
- <param name="yPos">Y position for rendering.</param>
- <param name="width">Width of the image.</param>
- <param name="height">Height of the image.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderBitmap(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Render bitmap
- </summary>
- <param name="bitmapToRender">Bitmap to render.</param>
- <param name="xPos">X position.</param>
- <param name="yPos">Y position.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderClubIcon(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Add bitmap on top, very similar to RenderSportIcon, but does not
- recolor to yellow! White parts of the image are converted to a
- transparent color.
- </summary>
- <param name="bitmapToRender">Bitmap to render.</param>
- <param name="xPos">X position.</param>
- <param name="yPos">Y position.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.RenderSportIcon(System.Drawing.Bitmap,System.Int32,System.Int32)">
- <summary>
- Add bitmap on top, makes white transparent and recolors everything
- to yellow.
- </summary>
- <param name="bitmapToRender">Bitmap to render.</param>
- <param name="xPos">X position for rendering.</param>
- <param name="yPos">Y position for rendering.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.MakeBorderTransparent(System.Int32)">
- <summary>
- Make border transparent
- </summary>
- <param name="pixelsPerBorder">Pixels per border</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.NormalizeNormalMap">
- <summary>
- Normalize each pixel/vector of a normal map.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapFilter.AddOutlineAndShadowPerPixel(System.Boolean,System.Boolean,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Add outline and shadow effects on a pixel basis. Used for font
- generation because outline glyph drawing on small fonts (size 12 or
- below) is very blurry and we want sharp pixel fonts for mobile
- devices.
- </summary>
- <param name="addOutline">if set to <c>true</c> [add outline].</param>
- <param name="addShadow">if set to <c>true</c> [add shadow].</param>
- <param name="outlineColor">Color of the outline.</param>
- <param name="shadowColor">Color of the shadow.</param>
- </member>
- <member name="P:Delta.Platforms.Windows.BitmapFilter.Bitmap">
- <summary>
- Get modified bitmap, setting only allowed in constructor
- </summary>
- </member>
- <member name="T:Delta.Platforms.Windows.BitmapFilter.ConvolutionMatrix">
- <summary>
- Helper class for convolution filters!
- Basically just a 3x3 matrix (or bigger for some filters)
- with values for each component, there is also a devidor
- we devide all values through and an additional offset.
- </summary>
- </member>
- <member name="T:Delta.Platforms.Windows.NativeMessageForm">
- <summary>
- Native message form
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.NativeMessageForm.WndProc(System.Windows.Forms.Message@)">
- <summary>
- Native message received.
- </summary>
- </member>
- <member name="E:Delta.Platforms.Windows.NativeMessageForm.NativeEvent">
- <summary>
- Native message event.
- </summary>
- </member>
- <member name="T:Delta.Platforms.Windows.WindowsApplication">
- <summary>
- Windows implementation for the Application.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowsApplication.SetEditorForm(System.Windows.Forms.Form,System.Windows.Forms.Control)">
- <summary>
- Set the specified window and render control for this application.
- This method is only used for editors or tools which need a different
- window around a rendering control. Start the Application normally via
- Application.Start. If you don't call this the engine will create its
- own window (outside of the editor application, if you want that ^^).
- </summary>
- <param name="setWindow">The editors window.</param>
- <param name="setControl">The control to render into</param>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowsApplication.SetEditorWPFWindow(System.Windows.Window,System.Windows.Forms.Integration.WindowsFormsHost)">
- <summary>
- Set the specified WPF window and render control for this application.
- This method is only used for editors or tools which need a different
- window around a rendering control. Start the Application normally via
- Application.Start. If you don't call this method for WPF applications
- the engine will still work and operate normally, but it won't render
- into the specified WPF control. Instead a new Windows Forms window is
- created like for normal non-WPF applications.
- </summary>
- <param name="setWindow">The editors window.</param>
- <param name="setHostControl">
- The WindowsFormsHost control to render into, if it has no children yet,
- an empty one to render into will be created automatically.
- </param>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowsApplication.MakeSureAppIsNotAlreadyRunning">
- <summary>
- Make sure app is not already running. Reference:
- http://www.codeproject.com/KB/cs/oneprocessonly.aspx
- Note: Since this is called for many tools first, we also do the
- ProjectName check here to set the Log.LogName for logging!
- </summary>
- <returns>
- False if we are the only process with our process name. Otherwise true
- is returned if there are other instances and we need to close our
- process and stop continuing starting up the engine.
- </returns>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowsApplication.#ctor">
- <summary>
- Create a new Windows Application, only allowed via Factory!
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowsApplication.Dispose">
- <summary>
- After the run loop returns, the we are done executing. Dispose main
- application modules and do some cleanup here. Dispose is based on the
- DynamicModule.Dispose, which does kill all the children modules for
- us automatically in the reverse order they were created and linked up.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.WindowsApplication.StartExecutionLoop">
- <summary>
- Start the execution loop. First check for some important stuff like
- graphics driver or already running instances of the game. If
- everything is fine we simply use the base method to start the game.
- </summary>
- </member>
- <member name="T:Delta.Platforms.Windows.Window">
- <summary>
- Window class for all platforms that support System.Windows.Forms.
- Unlike most other platform implementations (Xbox, iPhone, etc.) this
- implementation is quite heavy and powerful, we can handle windowed
- forms for games and testing, fullscreen mode is usually the default
- for games on windows and they have even better performance and finally
- we also support Editors via the EditorForm property, which will use a
- specific panel for rendering (used in all graphical tools and editors).
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.GetDefaultPlayerName">
- <summary>
- Get default player name from windows identity, and if this fails use
- computer name! Usually just used in DeltaLauncher and some tools.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.#ctor">
- <summary>
- Create window by creating a default empty form, which will be
- filled by the other Window constructor. Only allowed from the Factory!
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.#ctor(System.Windows.Forms.Form)">
- <summary>
- Create window with given Windows Form, this constructor is
- usually used for editors where we want to render into custom
- panels. For games we usually just use the empty constructor!
- Also only allowed from the Factory!
- </summary>
- <param name="setNativeForm">Set native form</param>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.Close">
- <summary>
- Closes the window. This will get rid of the native form or control,
- which we can only access here.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.HandlePlatformEvents">
- <summary>
- Handles all (native) platform events which waiting in the queue of the
- operating system. We don't use this much, maybe for Close, but most
- other events (like resizing) are already handled elsewhere.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.HideCursor">
- <summary>
- Hide the hardware mouse cursor (use ShowCursor to show it again). This
- makes especially sense for fullscreen games or if the game shows its
- own mouse cursor. Only used on Windows, other platforms ignore this
- (they don't show a hardware mouse cursor anyway).
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.OpenWebsite(System.String)">
- <summary>
- Open website with the specified url.
- </summary>
- <param name="url">website url</param>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.SetClipboardText(System.String)">
- <summary>
- Helper method to set clipboard text. We need to create a new STA thread
- and we need to handle COMExceptions that can happen when calling
- Clipboard.SetText. If all fails the method will log a warning.
- </summary>
- <param name="text">Text we want to set to the clipboard</param>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.Resize(System.Int32,System.Int32)">
- <summary>
- Resize helper function, will resize this window and set the new width
- and height values accordingly. Currently used for unit tests.
- Note: If the viewport size already matches this method does nothing!
- </summary>
- <param name="newWidth">The new width.</param>
- <param name="newHeight">The new height.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.ShowCursor">
- <summary>
- Show the hardware mouse cursor if it was hidden (see the Hide method).
- Please note that this is only useful on Windows because on all other
- platforms there won't be any hardware mouse cursor to show anyway.
- You can however show your own mouse cursor with lines, sprites or even
- in 3D if you like, this method just shows the Windows hardware cursor.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.ShowErrorDialog(System.String)">
- <summary>
- Show error dialog, nothing much to say here, will just display a
- windows forms dialog with OK to continue and cancel for aborting the
- current app because of the shown error (often unrecoverable anyway).
- Note: This will block the app and should only be called for serious
- errors that prevent us from continuing or that really need to inform
- the user (e.g. Graphic module could not be started).
- </summary>
- <param name="message">Message to display</param>
- <returns>
- True to ignore this error in the future
- </returns>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.ShowWarningDialog(System.String)">
- <summary>
- Same as ShowError, but just has an OK button to continue and will
- also output the warning into the log (ShowError is usually called
- from the Core.Error method anyway and has already log handling).
- </summary>
- <param name="message">Message to display</param>
- </member>
- <member name="M:Delta.Platforms.Windows.Window.DesktopToViewport(System.Int32,System.Int32)">
- <summary>
- Converts the desktop position of the operating system in the Viewport
- position.
- <para /><b>Note:</b> This only used by the WindowsTouch class.
- </summary>
- <param name="desktopPositionX">Desktop position x</param>
- <param name="desktopPositionY">Desktop position y</param>
- <returns>
- Point
- </returns>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.NativeForm">
- <summary>
- Native form, which holds the native windows form window. This can
- obviously be a derived class, but you need to cast it back to your
- type, so do not use this often, cache it somewhere instead!
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.Handle">
- <summary>
- The handle of the window as "anchor" for accessing it on low level
- logic, e.g. for input module. This is NOT necessary the same handle
- as ViewportHandle, which is used for rendering. The reason for this
- is on windows only the top handle for the form gets all the input
- events, client panels will not get mouse scroll events for example!
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.Title">
- <summary>
- The title the window, normally the name of the application.
- Set in the constructor here, but can also be set to anything else
- for games, editors or tools (e.g. displaying the current scene name).
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.Icon">
- <summary>
- Icon that is shown on the window in windowed mode and in the task bar
- (for windowed and fullscreen mode). Only used for windows.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.Location">
- <summary>
- Location of this window in desktop coordinates. Rarely used, but some
- input modules need this for the correct mouse position calculation.
- Not used if in fullscreen mode and if on a console or mobile platform.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.ViewportHandle">
- <summary>
- The handle of the control where we want to render, this can be the same
- as the window or an inner control.
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.ViewportOffset">
- <summary>
- Represents the relative offset in pixels between the window top-left
- position and the render surface position. This is often (0, 0),
- especially on non-windows platforms and on windows too in fullscreen.
- But if we have a editor form, the render surface might be some panel!
- </summary>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.ViewportPixelWidth">
- <summary>
- The width part of the drawing area size in pixels.
- </summary>
- <value>The width of the viewport in pixel.</value>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.ViewportPixelHeight">
- <summary>
- The height part of the drawing area size in pixels.
- </summary>
- <value>The height of the viewport in pixel.</value>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.IsResizable">
- <summary>
- Is this window resizable. Useful to disable the ability to resize
- a windowed mode window application. Will make the maximize box go away
- and make the borders fixed instead of sizable.
- </summary>
- <value>
- <c>True</c> if this window is resizable; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.IsClosed">
- <summary>
- Returns "true" if the windows is closed which means the application can
- resp. will be quit.
- </summary>
- <value>
- <c>true</c> if this instance is closed; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Delta.Platforms.Windows.Window.IsFocused">
- <summary>
- Is focused
- </summary>
- </member>
- <member name="E:Delta.Platforms.Windows.Window.NativeEvent">
- <summary>
- Occurs every time if a native message form the Operating System is
- sended to this window.
- </summary>
- </member>
- <member name="E:Delta.Platforms.Windows.Window.ResizeEvent">
- <summary>
- Resize event we can use to hock some extra code to it, usually just
- used to update the Screen aspect ratio for the projectionMatrix.
- </summary>
- </member>
- <member name="T:Delta.Platforms.Windows.BitmapHelper">
- <summary>
- Summary description for BitmapHelper.
- </summary>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.GetEncoderInfo(System.String)">
- <summary>
- Get encoder info
- </summary>
- <param name="mimeType">Mime type</param>
- <returns>Returns the codec information for the image.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.Save(System.Drawing.Bitmap,System.String,System.Drawing.Imaging.ImageFormat)">
- <summary>
- Save the bitmap to the specified file path.
- </summary>
- <param name="bmp">The Image instance.</param>
- <param name="name">The path to save the file to.</param>
- <param name="format">The format the image will be saved as.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpg(System.Int32,System.Int32,System.String,Delta.Utilities.Datatypes.Color[],System.Boolean)">
- <summary>
- Create a bitmap and save it as a jpg. This is only used in the OpenTK
- screenshot capturer which shouldn't have a reference to System.Drawing.
- </summary>
- <param name="width">Width of the image.</param>
- <param name="height">Height of the image.</param>
- <param name="name">File name of the image.</param>
- <param name="pixelData">Pixel color data of the image.</param>
- <param name="flipY">Should we flip the image horizontally before
- saving?</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpg(System.Int32,System.Int32,System.String,System.Byte[],System.Boolean)">
- <summary>
- Create a bitmap and save it as a jpg. This is only used in the OpenTK
- screenshot capturer which shouldn't have a reference to System.Drawing.
- </summary>
- <param name="width">Width of the image.</param>
- <param name="height">Height of the image.</param>
- <param name="name">File name of the image.</param>
- <param name="rgbData">Pixel color data of the image.</param>
- <param name="flipY">Should we flip the image horizontally before
- saving?</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpg(System.Drawing.Bitmap,System.String,System.Int32)">
- <summary>
- Save the given bitmap as a Jpg file
- </summary>
- <param name="bmp">The Bitmap to be saved</param>
- <param name="name">The Name of the resulting file</param>
- <param name="qualityPercent">The desired Quality percent of the
- resulting Jpg</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SavePng(System.Drawing.Bitmap,System.String)">
- <summary>
- Save png
- </summary>
- <param name="bmp">The Bitmap to be saved</param>
- <param name="name">The Name of the resulting file</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveAsRGBA(System.Drawing.Bitmap,System.String)">
- <summary>
- Save as .rgb or .rgba image for OpenGL.
- </summary>
- <param name="image">Image data to save out as an .rgba file</param>
- <param name="rgbaFilepath">Filename with extension for this raw file.
- Should be either .rgb for RGB 24 bit data or .rgba for 32 bit RGBA.
- </param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveJpgToStream(System.Drawing.Bitmap,System.IO.Stream,System.Int32)">
- <summary>
- Save jpg to stream
- </summary>
- <param name="bmp">The Bitmap to be saved</param>
- <param name="stream">The Stream containing the filepath where the
- jpg needs to be saved to.</param>
- <param name="qualityPercent">The desired Quality percent of the
- resulting Jpg</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SavePngToStream(System.Drawing.Bitmap,System.IO.Stream)">
- <summary>
- Save png to stream
- </summary>
- <param name="bmp">The Bitmap to be saved</param>
- <param name="stream">The Stream containing the file path where the
- jpg needs to be saved to.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.SaveBitmap(System.Drawing.Bitmap,System.String,System.Int32)">
- <summary>
- Save bitmap (choose jpg file if extension is .jpg, else save as bitmap)
- </summary>
- <param name="bmp">The BMP.</param>
- <param name="name">The name.</param>
- <param name="qualityPercent">The quality percent.</param>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.GetCachedBitmapWidth(System.String)">
- <summary>
- Get cached bitmap width. Bitmap widths do not change over time, and
- for example the smilies are ordered by their widths and we need
- that data over and over again.
- </summary>
- <param name="filename">Filename of the bitmap.</param>
- <returns>Bitmap width stored as an integer.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.GetRGBAImageData(System.String,Delta.Utilities.Datatypes.Size@,System.Boolean@)">
- <summary>
- Get RGBA image data
- </summary>
- <param name="bitmapFilename">The bitmap filename.</param>
- <param name="size">The size.</param>
- <param name="hasAlpha">if set to <c>true</c> [has alpha].</param>
- <returns>RGBA image data (32 bit = 4 byte per pixel)</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageHasAlpha(System.String)">
- <summary>
- Check if a png image has an alpha channel or not.
- This method is really fast because it only ready the first 26 bytes
- of the image file.
- </summary>
- <param name="filepath">Path to the png file.</param>
- <returns>True if image has alpha, otherwise false.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageHasAlpha(System.IO.Stream)">
- <summary>
- Check if a png image has an alpha channel or not.
- This method is really fast because it only ready the first 26 bytes
- of the image file.
- </summary>
- <param name="inputStream">Png file stream.</param>
- <returns>True if image has alpha, otherwise false.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageUsesAlpha(System.String)">
- <summary>
- Check if an image that has an alpha channel is really using it.
- </summary>
- <param name="filepath">Path to the png file.</param>
- <returns>True if image is using alpha, otherwise false.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.CheckImageUsesAlpha(System.Drawing.Bitmap)">
- <summary>
- Check if an image that has an alpha channel is really using it.
- </summary>
- <param name="filepath">Path to the png file.</param>
- <returns>True if image is using alpha, otherwise false.</returns>
- </member>
- <member name="M:Delta.Platforms.Windows.BitmapHelper.ExpandCanvas(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
- <summary>
- Expand the canvas of an image, e.g. place the original image
- inside a new bigger image.
- </summary>
- <param name="filepath">The original image.</param>
- <param name="expandLeft">Amount of expansion to the left.</param>
- <param name="expandTop">Amount of expansion to the top.</param>
- <param name="expandRight">Amount of expansion to the right.</param>
- <param name="expandBottom">Amount of expansion to the bottom.</param>
- <returns>Bitmap with the expanded canvas (bigger ^^)</returns>
- </member>
- </members>
- </doc>