Which assemblies do I use?
Which Gorgon assemblies you require will depend on what you intend to do. But, as a basic rule, you ALWAYS need to add a reference to Gorgon.Core.dll
. This assembly is required by all other assemblies.
Gorgon Assemblies
The following table will indicate the intended usage for each library:
Assembly Name | Purpose | Requires |
---|---|---|
Gorgon.Core.dll |
Core library, required. | N/A |
Gorgon.Windows.dll |
Required for using windows forms specific UI functionality, or other windows specific functionality such as timers. This assembly will be required most of the time if you are building anything utilizing Windows Forms. |
|
Gorgon.FileSystem.dll |
Required for using Gorgon's virtual file system functionality. Extra virtual file system types such as zip files, are provided via plug in interfaces. |
|
Gorgon.Input.dll |
Required for using Raw Input functionality for mouse/keyboard, and provides game device access (e.g. Xbox controllers, joysticks, etc...) via plug in interfaces. |
|
Gorgon.Graphics.Imaging.dll |
Provides functionality for accessing and manipulating raw image data in system memory. I/O functionality for loading/saving this image data is provide via codecs available in this API, common codecs like DDS, PNG, JPG are supported. Users may also implement their own codecs using a plug in interface. |
|
Gorgon.Graphics.Core.dll |
This is what you're likely here for. This provides low level functionality to send graphics data for rendering to the GPU. This is a core API, and as such only provides the bare minimum in functionality. External renderers are used to allow more complicated functionality. |
|
Gorgon.Graphics.Wpf.dll |
Provides WPF interoperability with Gorgon. |
|
Gorgon.Graphics.Fonts.dll |
Provides font generation facilities and saving/loading of font data using a font codec. Gorgon supports its own proprietary format, and importing of BMFont font types. Users may add their own custom codecs via plug in interfaces. |
|
Gorgon.Animation.dll |
Provides basic animation functionality. Animations are executed via controller objects which are defined by the objects that need animating. Users can define their own custom controllers for animating pretty much any type with the required property types. This is a core API, and as such only provides the bare minimum in functionality. External assemblies are used to allow more complicated functionality. |
|
Gorgon.Renderers.Gorgon2D.dll |
Provides 2D rendering functionality for drawing primitives like lines, circles, rectangles, etc... This renderer also provides support for rendering sprites and text. |
|
Gorgon.IO.Gorgon2D.dll |
Provides file system functionality for loading/saving sprites, and 2D animations. Meant for use with the 2D renderer. This assembly also allows applications to create their own file formats (for proprietary formats, or other external formats) for sprites/animations using plug in interfaces. |
|
Gorgon.Animation.Gorgon2D.dll |
Provides animation controllers for sprites and text sprites. |
|
Gorgon.Editor.API.dll |
Provides functionality for loading content data from a Gorgon Editor file system. It simplifies loading of content by loading dependencies (e.g. textures) on your behalf. This API can also be used for building plug ins for the Editor itself. |
|