T w e n t y S i d e d
Part 3 is up. Check it out, then my comments below:
Ugh. The example Microsoft code Michael shows us for DirectWrite is abominable. That’s about what I remember for DirectX programming as well. HUGE variable types, all over the place, mixed case, and cumbersome syntax. The end result is that even simple lines of code end up being very long, which is bad for readability. This is probably the #1 reason I work in OpenGL. I evaluated both in the 90’s, and found OpenGL to be far, far nicer to work with. Since then OpenGL has (reportedly) struggled a bit to keep up with the cutting-edge stuff. I suppose this would be bad if I rode the cutting edge, but I’d rather have it be slightly more cumbersome to load a pixel shader in one part of my program than have the ENTIRE program look like a wall of incomprehensible gibberish.
It’s really interesting how much my recent work is matching up with what Michael is doing this week. I said last week that I wrote my own program to produce Drawn to Knowledge. If you remember, that was this video:
Link (YouTube) |
My program isn’t nearly as clean or as polished as what Michael is doing. It took me over three days to create, and is still rough to the point of being unfit for public viewing. But I had to deal with both the file-format question and the font-drawing stuff.
For file writing, I took the easy and cheap way out. As Michael said, you have to remember to mark your files somehow so that they will be readable in the future. Like, if you are making a save game system for your game, and later in the project you decide to add a bit of data for keeping track of how long the player has played this particular character. If you don’t have a way of keeping track of versions, then the newer version of the game won’t be able to read old save game files. It will look for that “time played” stat, and (because it’s an old savegame) find some other bit of data in that spot. This will throw off reading of the file and generally lead to some sort of hilarious failure.
For my own saves, I need to save all of these little doodles. They’re actually pretty small. (The entire presentation you see above is just ~317k.) So I took the lazy way out and gave the file a needlessly huge header file. How that works is this: The project settings record stuff like what background I’m using and what line color I’m using. (The next video will show this off a bit more. It’s done in purple “crayon” on white paper.) That bit of information is actually just a few bytes. But when I save the file I write a great big 2k block of (mostly empty) data at the top of the file. If I add some feature in the future then I can just throw that data in that big empty space and not worry about the file size changing. It’s wasteful to do things this way. But hey: two thousand bytes. Screw it.
Here is a shot of the program used to produce the video:
 |
The font business was more annoying. I don’t actually need fonts for my program to do any drawing. That’s really my handwriting, although messier than my usual handwriting because I’m still getting used to the idea of a tablet. But for debugging I DO need to draw some stuff on screen. When something malfunctions, it’s helpful to have the program able to print text to the screen so it can tell me about what’s going on. Luckily, I didn’t need to worry about it looking pretty, since it’s just for my own use.
And because I know people will ask: The next Drawn To Knowledge will probably come out next week. I still thinking about when I should put it out, how often, what topics I should cover, how it should look, and how much time I’m willing o put into it.
In Defense of Crunch
Crunch-mode game development isn't good, but sometimes it happens for good reasons.
Punishing The Internet for Sharing
Why make millions on your video game when you could be making HUNDREDS on frivolous copyright claims?
Mass Effect 3 Ending Deconstruction
Did you dislike the ending to the Mass Effect trilogy? Here's my list of where it failed logically, thematically, and tonally.
Skylines of the Future
Cities: Skylines is bound to have a sequel sooner or later. Where can this series go next, and what changes would I like to see?
Object-Oriented Debate
There are two major schools of thought about how you should write software. Here's what they are and why people argue about it.
Ooh, net neutrality! Exciting stuff.
NERD!
I hope you say something about “regulatory capture”. You know, where they *say* they’ve passed net neutrality, but in fact have gotten cozy with industry and written something with huge holes in it. Over at http://www.techdirt.com/ they’ve been pretty skeptical of the FCC.
Don’t do net neutrality. You won’t like the conversation that arises unless you’re harboring a desire to turn these discussions into Shamus’s Conspiracy Corner. (In which case you might as well be timely and cover WikiLeaks first…)
You’re right, it is a hot-button issue and filled with rhetoric. My video is more of a gentle “here is what people are arguing about” and less “here is what I think about it.
We’ll see how well it goes.
Shamus I have 100% confidence in your ability to present an impartial and fact-based summary. And the people who read you are about as thoughtful and reasonable as you can get on the open web. So please don’t think I was impugning. I’m just saying I intend to duck and cover. :)
OK, I’m impressed you got that from the screen shot. I was staring at it and thinking: “huh, I don’t recognise that from the previous video”.
frequency: once every 2 weeks
coverage: anything hard to understand for laypeople you can explain in a simple way :D
I have an idea for a topic.
Error messages, and how much they suck due to how little they explain the actual problem.
I agree.
It’s alright Shamus; you don’t have to start up yet another project. You can have some free time. We’ll forgive you. (mostly)
I want this program; I think it could be an effective teaching tool for any subject (not just the ones you are using it for). Are there any plans to release this?
What he said. But for Mac, please.
Have you considered pitching Drawn to Knowledge to the Escapist? It seems like the sort of thing they’d be interested in running, and something that a large chunk of their audience would watch.
well, this is what i get for not reading all the comments first… (see below)
anyway, I am completely in favor of this
Commenting on save files – wouldn’t using XML also solve the problem of expansion? When you have new data to save, it just goes in a new tag/attribute/whatever — something that is basically ‘ignored’ by the old program.
You don’t even have to go XML, but can use binary TLVs instead. This is a common concept in protocol design (and basically what Roger describes below with different terminology).
PS. Please don’t advocate reserving space in front of a package (in your case a save file) for future purposes. This has proven to be a non-future-proof method time and time again, and has caused many a headache for people designing and extending network software.
I don’t understand why you need to reserve space for later, or even why it would be advantageous. Surely the header will include at least
A) The version information of the file.
and
B) Some indication that the end of the header has been reached. (xFFFF…)?
The software needs to know
A) Do I know how to parse this version of file?
If the file is too different, either a later or of an earlier, no longer supported, version, then refuse to load it.
Loadfile(file)
if ver=0.95 then parsefile(file, 0.95)
else if ver=1.0 then parsefile(file, 1.0)
else if ver=1.1 then parsefile(file, 1.1)
finally barf(File version not supported or file corrupt)
Again, I’m not a coder, but a math geek.
I’m a regular visitor to the escapist, and watch almost every video series posted there regularly (I love extra credits particularly)
Are there any plans to submit this to them as a regular series for them to run?
movie bob just got a second series, and they already publish your articles. This seems like something right up their alley.
if there’s anything you need in terms of a write-in campaign to make it happen, just let us know!
Oh boy… Me and a friend of mine also had issues with that safe stuff, and that was for a relatively easy program (we dubbed it ‘paintshop noob’)…
This question is most likely going to sound totally stupid to anyone with any kind of real experience in programming, but wouldn’t it be possible to insert a try/catch, and just ignore the whole time played aspect if it doesn’t work?
That would work with maybe one new tag/parameter.. Once you introduce five or more, the try-catch will get incessantly cluttered, compared to a switch or whatnot.
If new data is only added to the end, you could define zero as the default value for all your new stuff, and it would work OK.
Or you could do what Microsoft does, and use the length of the data structure to indicate which version it is. The new structures just add fields, and since the size increases, the code knows which version it’s dealing with.
If you are inserting data into the middle of the structure, or changing the meaning of an old field, then you have problems. If it’s just unformatted data, there’s no way for the loading code to know what has happened. It will misinterpret the new values, or even everything after the inserted value.
XML is a better solution because you can just add new attributes that weren’t in the old file. It’s more trouble to read though. A version number at the start of the file, so you know which version you are dealing with, works fine too. So does Shamus’s solution, as long as he never changes the meaning of an old field.
‘Microsoft, are you really forcing all of your programmers to write “static_cast(A)” instead of “(int) A” now?’
This I have an issue with, this is not a Microsoft thing, it’s a C++ thing, and it’s a good thing. C++ style casts (static_cast, dynamic_cast, const_cast and reinterpret) have many benefits over the c-style cast ( (int)etc.) mainly they’re safer, a static_cast has defined behaviour that is what most people want when they cast, as in, ‘Right now this is an int, but I want it as a float’, also very useful for polymorphism. const_cast will fail to compile for pretty much all invalid casting that will get you into trouble.
dynamic_cast, likewise is useful, as it will check the cast is valid at run-time and return a null pointer if not.
const_cast is useful when you’re dealing with a poorly coded library, but should be avoided elsewhere.
reinterpret_cast is evil, it says ‘This thing here is now this type, I don’t care what the compiler thinks’ which you should only do if you really, really know what you’re doing, and even then you probably shouldn’t.
Now the thing with ye-olde c-style cast is it will start of trying a const_cast, and if that doesn’t work it tries dynamic_cast, etc. All the way down to reinterpret_cast. This allows you to do evil you probably don’t want to do.
Also, it really must be a while since you’ve done games coding if you even considered GDI/GDI+ etc, which are horrendously slow and nasty.
And I couldn’t agree with you more about Microsoft’s odd function/variable names, terrible to type and one of the reasons I prefer OpenGL. Although DirectX does have more cutting edge features (it took the Khronos group forever to decide on a specification for the next OpenGL) and it also has the advantage of you not having to check if the graphics card you’re running on supports any of the un-official extensions you may want to make use of.
Apologies for the casting rant, I know it looks ugly and cumbersome but it’s good-practice.
On casts, I’m sympathetic to what you say if we’re talking about complex types. There, it really does matter if you corrupt pointers with a bad cast from one type to another.
But for casting an int to a float? Please… this is just ugly visual noise added to your program for no reason. C++ code will never be beautiful, but you don’t have to whack it in the face with a crowbar.
Oh, and what do people use these days for Windows graphics if not GDI, GDI+?
I get that it’s pretty pointless for intrinsic types, but better to use the same all over the place? I dunno (I’m one of the strange people that think C++ is beautiful, in a strange way, and find C# / Java kinda ugly)
And for windows graphics? Possibly still GDI/GDI+ (I assume that’s what .NET uses under the hood) but for games it’s pretty much OpenGL/DirectX/Both, pick your poison on that one though, essays can (and most likely have) been written on the merits of both.
Actually, the old .Net GUI library (called Winforms) does use GDI+, but the new library called WPF (and related to Silverlight) does its own rendering.
Direct3D 9 actual output
Well, if you want to use the less safe c-cast instead, you still can! Nobody will stop you! So please guys, don’t complain about stuff that is optional (and more often than not a huge improvement). Also doing a for-loop and then casting the int to float isn’t what I would call clever to begin with, so it’s pretty much down to “that example is just bad style”, and has nothing to do with DirectX itself. If you look at the calls themselves, they are quite sensible, much more so than the cryptic OpenGL (or even worse: MFC) stuff of old.
Complaining about static_cast being cumbersome only shows how little the complainer knows about C++. I’d rather spend two seconds to type “static_cast” than I spend half an hour searching for that mysterious segmentation fault. And as for readability: Number of letters doesn’t matter as much as how easy they are to understand. Sure,
“if (a > 0) and (x = a) then begin a := a + 5 + x else a := a+n endif”
(Pascal) is long, but
a+=(a>0&&x==a)?5+x:n;
is way harder to read, despite being significantly shorter. And everything that has more than one meaning is hard to understand. (int) has FOUR possible meanings (ignoring possible operator overload), whereas static_cast has exactly one.
I would also point the more experienced programmers to http://blogs.msdn.com/b/oldnewthing/ for more “ARRGHHH?” ;)
Actually, since I’m more used to it, I read the ‘a+=(a>0&&x==a)?5+x:n;’ much faster, but then I’m pretty sure my brain parses C++ better than English
I think any subject that makes Computers, Games (Even table-top ones!) less ubiquitous and easier to explain to the uninitiated would be great. Generally, if you can take any subject that’s nearly incomprehensible and fairly boring, but interesting to know, and make it fun (Chalk, Crayons, and Humor) and easy to understand, you’ve got an audience.
True intelligence isn’t being able to understand something, it’s being able to take a subject that is vast and complex and explain it so a child could understand.
Except for the most arcane subjects, if you can’t explain it to a layman, you probably don’t fully understand it yourself. This goes for just about everything.
Not sure if this is where it belongs, but how long has that winter theme been up at the top? I like it.
Only a few hours. And I agree, it looks suitably Christmas-y :)
Shamus, as some have pointed out xml is very practical, and it’s even editable with a editor like Notepad++ so very convenient for development testing.
Alternatively just a variant on the generic .ini could be used.
If you wanna go binary then you should do the following instead:
And in Shamus’s case the BINID could be:
Drawn to Knowledge Project
And all settings and actual project data could easily be stored in that single file,
it would be extensible and expandable, future versions can read previous versions,
redundant/deprecated data is simply ignored (alternatively converted to new version under loading)
Heck, by simply changing the BINID you could re-use this for almost any kind of project/program/game etc.
In a way it even works as a crude archive format of sorts.
And if too outdated/old many years from now it’s possible to parse and rescue what you can from it since you know thanks to the format, what is supposed to be exactly what, even if using a completely different programming language.
Basically what I just created here was a sort of binary concept of what XML is for text.
Although that being said I guess you could also just use XML and do it in a similar way to how I outlined it all here, it’s a bit more messy to to store binary inside a XML file though.
I’d rather have human-readable XML. Might be slower and fatter, but way easier to debug. And debugging is where I spend 90% of my programming time, so optimisations count. I want to point people (again) to pugiXML. I rewrote our import/export this week, from TinyXML to PugiXML. It took me about 30 minutes per 100 lines of code (which is LUDICROUS SPEED) and spent another 10 minutes to find all errors I made. It’s a great piece of code.
I’ve always been VERY disappointed with XML parser libraries – I’ll have to check out PugiXML then. I’ve actually found text formats – even my preferred JSON – to be much harder to parse than binary formats, there is *way* more book-keeping to do. Also, round-tripping floating point is very dangerous, inexact parsers are *very* common (David Gay’s dtoa.c is pretty much *the* implementation of strtod() and dtoa()).
EDIT: re the proposed format – no need to be so complicated – you can get away with just { uint16 kind; uint16 length; byte data[length]; } for almost all formats, SWF for example is pretty close to running DEFLATE over that (they optimize for short tags). You do have to think whether you want to be able to reference other tags (add “id”), or have forward compatible tags so older readers can read newer files (I don’t recommend this, but if you want, add “version”). The point is that normally, if you don’t know how to read it, it’s because you cant use it – so there’s no point in a self-describing file. If you do want something like that, check out .blender files (yes, the 3d modeller’s format). I also think OLE structured storage (old style binary word documents) are cool, they essentially implement a filesystem in a file, with a page table, sectors, folders, file types, and a bunch of other stuff. Unfortunately, the partial updating it gives you also means its easier to get a corrupt file :(.
Oh and since we’re talking about programming and etc.
Mark Russinovich’s videos is a must:
http://www.msteched.com/2010/Europe/WCL401
http://www.msteched.com/2010/Europe/WCL402
Those two links cover Windows memory use and management, learn what the Task Manager numbers actually mean.
“Silverlight is required to view TechEd videos online”. What a pitty!
By the way, it’s the first time I see a site with this technology, that even Microsoft consider futureless.
Just wanted to point out something that has nothing to do with this post:
I like your Christmas decoractions!
Can I make a suggestion?
Remember RedLetterMedia’s wonderfully psychopathic review of Star Wars: the Phantom Menace? It had a subtle musical back beat behind it at all times (much like your intro song.) It was below notice, but made the whole thing infinitely more watchable, because it gave the video a pace, and some flow.
What you have is wonderful, but educational videos get boring to non-nerds real quick. If you included a beat, the wider audience’s interest might be retained better.
Just a thought, anyway.
You are a wise man. I’ve made tutorial videos of my own and I never realized that glaring omission until just now. I thank you and so does anyone who will have to watch my “wish-I-could-do-better-than-powerpoint-capture” presentations.
It’s educational, but can I dance to it?