Installation Instructions

The SDX STR framework is delivered as CLR dynamic link libraries (DLL). Because it supports several DirectX libraries, the SpriteTextRenderer is split into multiple DLLs. Add a reference to the appropriate files and you're ready to go. Make sure to enable local copies of the reference.

The library was developed and tested with the SlimDX/SharpDX versions stated in the System Requirements. However, it may work with other versions as well.

Which files should I choose for my project?

All common features of the SDX STR are located in the SpriteTextRenderer DLL. You will always need to add a reference to this file. The need for further files depends on your application:

If your application utilizes SlimDX, add a reference to SpriteTextRenderer.SlimDX. If it uses SharpDX, add a reference to SpriteTextRenderer.SharpDX. If it uses both, you can add both references, although this is not recommended and probably does not make much sense in most cases.

Of course, you need to reference the DirectX library that you use. SharpDX applications will need these DLLs:

  • SharpDX
  • SharpDX.D3DCompiler
  • SharpDX.Direct2D1
  • SharpDX.Direct3D11
  • SharpDX.Direct3D11.Effects
  • SharpDX.DXGI
  • sharpdx_direct3d11_effects_x64 / x86

Class Documentation

A full class documentation is provided with the releases as a compiled help file (CHM). The class documentation also includes examples and further information.

Concepts and Tutorials

In order to allow an easy usage of the SpriteTextRenderer library, you can find explanations about the concepts and tutorials in this section of the documentation.

Eric Richards has written a short tutorial about the SDX SpriteTextRenderer. He also developed a FontCache that is able to manage several Fonts. Although the tutorial is based on an older version of the SDX STR, it should work equally well with newer versions. Here is the link.

Last edited Oct 25, 2014 at 8:51 AM by Nico201, version 12