Dependency Injection in XNA

The benefits of using Dependency Injection/IoC are more or less obvious, for an "academic" argument search the internets. Anyway, I started coding using the "Manager classes with static methods" style seen in most of the XNA tutorials and pretty soon my code became "spaghetized" and I realized that I really missed having an IoC container. After a few searches it appeared that I would have to make one - I would have used springframework.net or Castle or Unity or whatever but all of them seem to be using Reflection.Emit which is not available on the Xbox360. Plus they just do way to much for what a game needs.

Code is not ready for public consumption just yet, but I'll clean it up and publish as soon as I can.

Anyway, it's called Radiality and it has all the features you would expect from an IoC container, life cycle management, singletons, prototypes, auto-wiring, late injection, look up by interface or name and a few more thing I forgot about.

Here is what it looks like in action.

view plainprint?

1. container = new RadialityContainer();  
2.   
3. container.Bind<GameConsole>("Console").To(delegate(RadialityContainer r) {  
4.     Game1 game1 = r.Get<Game1>();  
5.     GameConsole console = new GameConsole(game1);  
6.     game1.Components.Add(console);  
7.     return console;  
8.    });  
9.   
10. r.Bind<SpriteFont>("ConsoleFont").To(delegate {  
11.      Game1 game1 = r.Get<Game1>();  
12.      return game1.Content.Load<SpriteFont>("Fonts/LiberationMono12");  
13.     }).InjectNow();  
14.   
15. r.Bind<Texture2D>("ConsoleBackgroundTexture").To(delegate {  
16.      Game1 game1 = r.Get<Game1>();  
17.      return game1.Content.Load<Texture2D>("Textures/ConsoleBackground");  
18.     }).InjectNow();  
19.   
20. container.Bind<Gameplay>().To(delegate(RadialityContainer r) {  
21.     Game1 game1 = r.Get<Game1>();  
22.     Gameplay gameplay = new Gameplay(game1, null, r);  
23.     return gameplay;  
24.    });  

<br />container = new RadialityContainer();<br /><br />container.Bind<GameConsole>("Console").To(delegate(RadialityContainer r) {<br /> Game1 game1 = r.Get<Game1>();<br /> GameConsole console = new GameConsole(game1);<br /> game1.Components.Add(console);<br /> return console;<br /> });<br /><br />r.Bind<SpriteFont>("ConsoleFont").To(delegate {<br /> Game1 game1 = r.Get<Game1>();<br /> return game1.Content.Load<SpriteFont>("Fonts/LiberationMono12");<br /> }).InjectNow();<br /><br />r.Bind<Texture2D>("ConsoleBackgroundTexture").To(delegate {<br /> Game1 game1 = r.Get<Game1>();<br /> return game1.Content.Load<Texture2D>("Textures/ConsoleBackground");<br /> }).InjectNow();<br /><br />container.Bind<Gameplay>().To(delegate(RadialityContainer r) {<br /> Game1 game1 = r.Get<Game1>();<br /> Gameplay gameplay = new Gameplay(game1, null, r);<br /> return gameplay;<br /> });<br />

Blogging is hard

Phew, I just finished my first serious post and I must say, blogging is hard and I kept having "Barbie moments".

Blogger is not terribly "programmer friendly" - there is no plugin or whatever they call it to post source code - I eventually found out about various javascripts that would solve the problem, settled on syntaxhighlighter, almost gave up on using after seeing that it needs to be hosted somewhere and finally figured out that I can point directly to the Subversion repository.

Phew again. Now I get to post some source code - but it looks all wrong, the code lines are too long and they wrap and it looks pretty bad - and of course I can't get Visual Studio to do nice line wrapping (maybe ReSharper would help but I cannot afford it). I manually get to format my code to approximately 80 characters per line.

Almost there, but the Blogger WYSIWYGWSYGFYGFWSYG editor keeps messing up the paragraphs so I have to edit in the HTML view - retarded - but I get used to it.

And I still can't figure out how to attach a file to a post, probably need to host it externally ...

Update: I found a widget based on syntaxhighlighter that makes things a bit easier.

Rendering a model from the XNA Content Pipeline

When starting a new project you begin with the "fundamentals" (especially if you suffer from the NIH syndrome), you build frameworks, toolkits and all kinds of fun stuff - what I mean is that I have not started working on my game yet :). The most recent of these tools is a Content Pipeline processor that renders a model to a texture. Before you say that this is useless keep reading. One day I was trying to render a terrain heightmap from Blender (there are tutorials here and here) and it hit me, why not render from the pipeline, this would streamline my workflow a little by eliminating the scene rendering step in Blender. All I needed to do was to draw the model using an orthographic projection with a shader that outputs the model height.
So here is the shader:

float4x4 World;
float4x4 View;
float4x4 Projection;

void Transform (float4 position : POSITION, out
    float4 outPosition : POSITION,
    out float3 outPixelPosition : TEXCOORD0) {
    float4x4 worldViewProjection = mul(mul(World, View), Projection);
    outPosition = mul(position, worldViewProjection);
    outPixelPosition = outPosition.xyz;
}

float4 Heightmap(float3 pixelPosition : TEXCOORD0): COLOR {
    float h = 1 - pixelPosition.z;
    float4 height = float4(h, h, h, 1.0f);
    return height;
}

technique BasicShader {
    pass P0 {
        VertexShader = compile vs_2_0 Transform();
        PixelShader = compile ps_2_0 Heightmap();
    }
}

Pretty simple stuff, just transform and then output the height of the vertex as the color. The projection is orthographic so the Z is already between 0 and 1, no need to scale the value or anything like that.

To the content processor now, (I'm not going to go through the moves of creating a content processor project, there is plenty of documentation on the internets), here is the class and the Process method. We create a graphics device and load the shader, then we set up a render target and draw the model using our shader and finally we take the pixel data and return a texture content with it.

view plainprint?

1. namespace Vendazoa.Content.Pipeline {  
2.     [ContentProcessor(DisplayName = "Orthographic Renderer - Vendazoa Toolkit")]  
3.     [Description(  
4.         "Renders the input model to a texture using an orthographic projection.")]  
5.     public class OrthoRenderer : ContentProcessor<NodeContent, Texture2DContent> {  
6.         public override Texture2DContent Process(NodeContent input,  
7.                                                  ContentProcessorContext context){  
8.             //Obviously all the rendering is off screen, no form shows up, but it  
9.             //would be funny if it would. Oh well, maybe some other time.  
10.             //We only need the form handle to create the GraphicsDevice,   
11.             //trying to pass a fake one does not seem to work.  
12.             using (Form form = new Form()) {  
13.                 PresentationParameters pp = new PresentationParameters();  
14.                 pp.BackBufferWidth = (int)textureSize.X;  
15.                 pp.BackBufferHeight = (int)textureSize.Y;  
16.                 pp.BackBufferFormat = surfaceFormat;  
17.                 using (  
18.                     GraphicsDevice device =  
19.                         new GraphicsDevice(  
20.                             GraphicsAdapter.DefaultAdapter,  
21.                             DeviceType.Hardware,  
22.                             form.Handle,  
23.                             pp)) {  
24.                     Effect effect = CreateEffect(  
25.                         effectName,  
26.                         Path.GetDirectoryName(input.Identity.SourceFilename),  
27.                         device);  
28.                     RenderTarget2D renderTarget = new RenderTarget2D(  
29.                         device,  
30.                         device.PresentationParameters.BackBufferWidth,  
31.                         device.PresentationParameters.BackBufferHeight,  
32.                         1,  
33.                         device.DisplayMode.Format,  
34.                         MultiSampleType.None,  
35.                         1);  
36.                     device.SetRenderTarget(0, renderTarget);  
37.                     device.Clear(Color.Black);  
38.   
39.                     ModelContent model = new ModelProcessor().Process(  
40.                         input, context);  
41.                     //Create a bounding box that will be used to set up the   
42.                     //orthographic projection.  
43.                     BoundingBox modelBoundingBox = GetBoundingBox(  
44.                         input.Children, new BoundingBox());  
45.                     Vector3 sz = modelBoundingBox.Max - modelBoundingBox.Min;  
46.                     float min = MathHelper.Min(sz.X, sz.Y) * (100 - crop) / 100;  
47.   
48.                     Matrix proj = Matrix.CreateOrthographic(min, min, 0, sz.Z);  
49.                     Matrix view = Matrix.CreateLookAt(  
50.                         cameraPosition, Vector3.Zero, Vector3.Up);  
51.                     Matrix world = Matrix.Identity;  
52.                     effect.Parameters["Projection"].SetValue(proj);  
53.                     effect.Parameters["View"].SetValue(view);  
54.                     effect.Parameters["World"].SetValue(world);  
55.   
56.                     Draw(device, effect, model);  
57.   
58.                     device.SetRenderTarget(0, null);  
59.                     Texture2D texture2D = renderTarget.GetTexture();  
60.                     byte[] buf =  
61.                         new byte[texture2D.Height * texture2D.Width * 4];  
62.                     texture2D.GetData(buf);  
63.                     PixelBitmapContent<Color> pix =  
64.                         new PixelBitmapContent<Color>(  
65.                             texture2D.Width, texture2D.Height);  
66.                     pix.SetPixelData(buf);  
67.   
68.                     Texture2DContent texture2DContent = new Texture2DContent();  
69.                     texture2DContent.Mipmaps = pix;  
70.                     return texture2DContent;  
71.                 }  
72.             }  
73.         }  
74.     }  
75. }  

<br />namespace Vendazoa.Content.Pipeline {<br /> [ContentProcessor(DisplayName = "Orthographic Renderer - Vendazoa Toolkit")]<br /> [Description(<br /> "Renders the input model to a texture using an orthographic projection.")]<br /> public class OrthoRenderer : ContentProcessor<NodeContent, Texture2DContent> {<br /> public override Texture2DContent Process(NodeContent input,<br /> ContentProcessorContext context){<br /> //Obviously all the rendering is off screen, no form shows up, but it<br /> //would be funny if it would. Oh well, maybe some other time.<br /> //We only need the form handle to create the GraphicsDevice, <br /> //trying to pass a fake one does not seem to work.<br /> using (Form form = new Form()) {<br /> PresentationParameters pp = new PresentationParameters();<br /> pp.BackBufferWidth = (int)textureSize.X;<br /> pp.BackBufferHeight = (int)textureSize.Y;<br /> pp.BackBufferFormat = surfaceFormat;<br /> using (<br /> GraphicsDevice device =<br /> new GraphicsDevice(<br /> GraphicsAdapter.DefaultAdapter,<br /> DeviceType.Hardware,<br /> form.Handle,<br /> pp)) {<br /> Effect effect = CreateEffect(<br /> effectName,<br /> Path.GetDirectoryName(input.Identity.SourceFilename),<br /> device);<br /> RenderTarget2D renderTarget = new RenderTarget2D(<br /> device,<br /> device.PresentationParameters.BackBufferWidth,<br /> device.PresentationParameters.BackBufferHeight,<br /> 1,<br /> device.DisplayMode.Format,<br /> MultiSampleType.None,<br /> 1);<br /> device.SetRenderTarget(0, renderTarget);<br /> device.Clear(Color.Black);<br /><br /> ModelContent model = new ModelProcessor().Process(<br /> input, context);<br /> //Create a bounding box that will be used to set up the <br /> //orthographic projection.<br /> BoundingBox modelBoundingBox = GetBoundingBox(<br /> input.Children, new BoundingBox());<br /> Vector3 sz = modelBoundingBox.Max - modelBoundingBox.Min;<br /> float min = MathHelper.Min(sz.X, sz.Y) * (100 - crop) / 100;<br /><br /> Matrix proj = Matrix.CreateOrthographic(min, min, 0, sz.Z);<br /> Matrix view = Matrix.CreateLookAt(<br /> cameraPosition, Vector3.Zero, Vector3.Up);<br /> Matrix world = Matrix.Identity;<br /> effect.Parameters["Projection"].SetValue(proj);<br /> effect.Parameters["View"].SetValue(view);<br /> effect.Parameters["World"].SetValue(world);<br /><br /> Draw(device, effect, model);<br /><br /> device.SetRenderTarget(0, null);<br /> Texture2D texture2D = renderTarget.GetTexture();<br /> byte[] buf =<br /> new byte[texture2D.Height * texture2D.Width * 4];<br /> texture2D.GetData(buf);<br /> PixelBitmapContent<Color> pix =<br /> new PixelBitmapContent<Color>(<br /> texture2D.Width, texture2D.Height);<br /> pix.SetPixelData(buf);<br /><br /> Texture2DContent texture2DContent = new Texture2DContent();<br /> texture2DContent.Mipmaps = pix;<br /> return texture2DContent;<br /> }<br /> }<br /> }<br /> }<br />}<br />
The effect loading method employed below is only "slightly" INSANE, if anybody finds a better way of loading an effect in the content pipeline let me know - I tried, I really tried to load a compiled .xnb effect without using a ContentManager but it did not seem possible without recreating a lot of code from the ContentReader. Also, this method does a fair amount of work, it will first look for a .xnb file and if not found it will try to load and compile a .fx file and finally it will try to load the effect from the internal resources.

view plainprint?

1. private Effect CreateEffect(String effectName, String path,  
2.                             GraphicsDevice device){  
3.     //I create a phony IServiceProvider (GameServiceContainer) with a fake   
4.     //IGraphicsDeviceService and then I feed it to the gullible ContentManagers.   
5.     //From what I have seen with the Reflector the only thing that the ContentManager   
6.     //will ask the IServiceProvider is a IGraphicsDeviceService so this seems to   
7.     //keep it happy.  
8.     GameServiceContainer gsc = new GameServiceContainer();  
9.     gsc.AddService(  
10.         typeof(IGraphicsDeviceService),  
11.         new FakeGraphicsDeviceService(device));  
12.   
13.     Effect effect = null;  
14.     String effectPath = Path.Combine(path, effectName);  
15.     if (File.Exists(effectPath + ".xnb")) {  
16.         ContentManager contentManager = new ContentManager(gsc);  
17.         effect = contentManager.Load<Effect>(effectPath);  
18.     } else if (File.Exists(effectPath + ".fx")) {  
19.         effectPath += ".fx";  
20.         CompiledEffect compiledEffect =  
21.             Effect.CompileEffectFromFile(  
22.                 effectPath,  
23.                 null,  
24.                 null,  
25.                 CompilerOptions.None,  
26.                 TargetPlatform.Windows);  
27.         effect = new Effect(  
28.             device,  
29.             compiledEffect.GetEffectCode(),  
30.             CompilerOptions.None,  
31.             null);  
32.     } else {  
33.         ResourceManager rm =  
34.             new ResourceManager(  
35.                 "VendazoaContentPipeline.Resources", GetType().Assembly);  
36.         ResourceContentManager resourceContentManager =  
37.             new ResourceContentManager(gsc, rm);  
38.         effect = resourceContentManager.Load<Effect>(effectName);  
39.     }  
40.     return effect;  
41. }  

<br /> private Effect CreateEffect(String effectName, String path,<br /> GraphicsDevice device){<br /> //I create a phony IServiceProvider (GameServiceContainer) with a fake <br /> //IGraphicsDeviceService and then I feed it to the gullible ContentManagers. <br /> //From what I have seen with the Reflector the only thing that the ContentManager <br /> //will ask the IServiceProvider is a IGraphicsDeviceService so this seems to <br /> //keep it happy.<br /> GameServiceContainer gsc = new GameServiceContainer();<br /> gsc.AddService(<br /> typeof(IGraphicsDeviceService),<br /> new FakeGraphicsDeviceService(device));<br /><br /> Effect effect = null;<br /> String effectPath = Path.Combine(path, effectName);<br /> if (File.Exists(effectPath + ".xnb")) {<br /> ContentManager contentManager = new ContentManager(gsc);<br /> effect = contentManager.Load<Effect>(effectPath);<br /> } else if (File.Exists(effectPath + ".fx")) {<br /> effectPath += ".fx";<br /> CompiledEffect compiledEffect =<br /> Effect.CompileEffectFromFile(<br /> effectPath,<br /> null,<br /> null,<br /> CompilerOptions.None,<br /> TargetPlatform.Windows);<br /> effect = new Effect(<br /> device,<br /> compiledEffect.GetEffectCode(),<br /> CompilerOptions.None,<br /> null);<br /> } else {<br /> ResourceManager rm =<br /> new ResourceManager(<br /> "VendazoaContentPipeline.Resources", GetType().Assembly);<br /> ResourceContentManager resourceContentManager =<br /> new ResourceContentManager(gsc, rm);<br /> effect = resourceContentManager.Load<Effect>(effectName);<br /> }<br /> return effect;<br /> }<br />
And here is the IGraphicsDeviceService implementation.

view plainprint?

1. internal class FakeGraphicsDeviceService : IGraphicsDeviceService {  
2.     private readonly GraphicsDevice graphicsDevice;  
3.   
4.     public FakeGraphicsDeviceService(GraphicsDevice graphicsDevice){  
5.         this.graphicsDevice = graphicsDevice;  
6.     }  
7.   
8.     public event EventHandler DeviceCreated;  
9.     public event EventHandler DeviceDisposing;  
10.     public event EventHandler DeviceReset;  
11.     public event EventHandler DeviceResetting;  
12.   
13.     public GraphicsDevice GraphicsDevice{  
14.         get { return graphicsDevice; }  
15.     }  
16. }  

<br /> internal class FakeGraphicsDeviceService : IGraphicsDeviceService {<br /> private readonly GraphicsDevice graphicsDevice;<br /><br /> public FakeGraphicsDeviceService(GraphicsDevice graphicsDevice){<br /> this.graphicsDevice = graphicsDevice;<br /> }<br /><br /> public event EventHandler DeviceCreated;<br /> public event EventHandler DeviceDisposing;<br /> public event EventHandler DeviceReset;<br /> public event EventHandler DeviceResetting;<br /><br /> public GraphicsDevice GraphicsDevice{<br /> get { return graphicsDevice; }<br /> }<br /> }<br />
There is nothing special about the drawing method below, just that it took me some time to figure out how to properly get the vertex and index buffer from a ModelContent which is almost, but not quite, entirely unlike the ModelMesh.

view plainprint?

1. private void Draw(GraphicsDevice device, Effect effect,  
2.                          ModelContent model){  
3.     effect.Begin();  
4.     foreach (EffectPass pass in effect.CurrentTechnique.Passes) {  
5.         pass.Begin();  
6.         foreach (ModelMeshContent mesh in model.Meshes) {  
7.             if (mesh.VertexBuffer == null)  
8.                 continue;  
9.             VertexBuffer vertexBuffer = new VertexBuffer(  
10.                 device,  
11.                 typeof(byte),  
12.                 mesh.VertexBuffer.VertexData.Length,  
13.                 BufferUsage.None);  
14.             vertexBuffer.SetData<byte>(mesh.VertexBuffer.VertexData);  
15.   
16.             int[] ib = new int[mesh.IndexBuffer.Count];  
17.             mesh.IndexBuffer.CopyTo(ib, 0);  
18.             IndexBuffer indexBuffer = new IndexBuffer(  
19.                 device,  
20.                 sizeof(int) * mesh.IndexBuffer.Count,  
21.                 BufferUsage.None,  
22.                 IndexElementSize.ThirtyTwoBits);  
23.             indexBuffer.SetData<int>(ib);  
24.             device.Indices = indexBuffer;  
25.   
26.             foreach (ModelMeshPartContent part in mesh.MeshParts) {  
27.                 VertexElement[] vertexElements =  
28.                     part.GetVertexDeclaration();  
29.                 VertexDeclaration vertexDeclaration =  
30.                     new VertexDeclaration(  
31.                         device, part.GetVertexDeclaration());  
32.                 device.VertexDeclaration = vertexDeclaration;  
33.                 device.Vertices[0].SetSource(  
34.                     vertexBuffer,  
35.                     part.StreamOffset,  
36.                     VertexDeclaration.GetVertexStrideSize(  
37.                         vertexElements, 0));  
38.                 device.DrawIndexedPrimitives(  
39.                     PrimitiveType.TriangleList,  
40.                     part.BaseVertex,  
41.                     0,  
42.                     part.NumVertices,  
43.                     part.StartIndex,  
44.                     part.PrimitiveCount);  
45.             }  
46.         }  
47.         pass.End();  
48.     }  
49. }  

<br /> private void Draw(GraphicsDevice device, Effect effect,<br /> ModelContent model){<br /> effect.Begin();<br /> foreach (EffectPass pass in effect.CurrentTechnique.Passes) {<br /> pass.Begin();<br /> foreach (ModelMeshContent mesh in model.Meshes) {<br /> if (mesh.VertexBuffer == null)<br /> continue;<br /> VertexBuffer vertexBuffer = new VertexBuffer(<br /> device,<br /> typeof(byte),<br /> mesh.VertexBuffer.VertexData.Length,<br /> BufferUsage.None);<br /> vertexBuffer.SetData<byte>(mesh.VertexBuffer.VertexData);<br /><br /> int[] ib = new int[mesh.IndexBuffer.Count];<br /> mesh.IndexBuffer.CopyTo(ib, 0);<br /> IndexBuffer indexBuffer = new IndexBuffer(<br /> device,<br /> sizeof(int) * mesh.IndexBuffer.Count,<br /> BufferUsage.None,<br /> IndexElementSize.ThirtyTwoBits);<br /> indexBuffer.SetData<int>(ib);<br /> device.Indices = indexBuffer;<br /><br /> foreach (ModelMeshPartContent part in mesh.MeshParts) {<br /> VertexElement[] vertexElements =<br /> part.GetVertexDeclaration();<br /> VertexDeclaration vertexDeclaration =<br /> new VertexDeclaration(<br /> device, part.GetVertexDeclaration());<br /> device.VertexDeclaration = vertexDeclaration;<br /> device.Vertices[0].SetSource(<br /> vertexBuffer,<br /> part.StreamOffset,<br /> VertexDeclaration.GetVertexStrideSize(<br /> vertexElements, 0));<br /> device.DrawIndexedPrimitives(<br /> PrimitiveType.TriangleList,<br /> part.BaseVertex,<br /> 0,<br /> part.NumVertices,<br /> part.StartIndex,<br /> part.PrimitiveCount);<br /> }<br /> }<br /> pass.End();<br /> }<br /> }<br />
And now the proof. This is the original mesh in Blender, notice the little axis icon on the bottom right corner - the Z is up, make sure the FBX exporter rotates the model to match the XNA coordinate system.

Now the processor options and the generated heightmap:


If you create a terrain using this heightmap and everything goes well you should get something very similar with your original model.

"The resemblance is striking"

Here is a tip, if you experience a stair stepping effect (you'll know when you see it) try to reduce the resolution of the image when creating the heightmap texture (see this explanation).
I think this processor could be used for some other things, like rendering sprites or UI elements, pretty much anything that you would model in 3d and then export as image would be a good use case if the rendering quality is not terribly important.

That's it for now, I hope this was useful. Questions? Suggestions? Go ahead, ask and suggest...

A shiny new blog

Hello and welcome to my shiny new blog.

So why is this blog here? About a month ago I decided to learn C# and soon after that I needed a fun pet project to exercise my newly acquired "skills" because things were getting boring real fast (I'm not a big fan of doing web apps and winforms).

Somehow, don't remember exactly, I stumbled upon creators.xna.com and in no time I was staring in awe at a CornflowerBlue screen. Next, I looked at a few samples, read some blogs, skimmed through the forum posts, and that was it, I just had to make a game, after all XNA should make it easy, right?

One thing that I noticed is that almost everyone posting in any of the XNA forums has a blog to document the progress of their latest and greatest game/engine, so here is mine. And of course I will make the greatest game evar!!!

Anyway, enough small talk, welcome to my shiny new blog.