Forum Home | Login

GreenReaper

Join Date 05/2001

+27

Building a Better Snowflake

Scaling DesktopX to 1000s of Objects for Fun and Profit

The script described in the article below is available for use in free DesktopX objects - see the snowman's script for details.

This is really as much an article on what mistakes to avoid as it is an article on creating flakes - if you just want to see the end result, skip to the end (or try clicking this link to get to the object). As WinCustomize is having a problem with submitting skins for Journeymen right now, I've duplicated the object description and shots here, as well as links to download the object.

Introduction

Snowflakes are nice. I think we all like to see them - just as long as we don't have to go out in them!

However, I had a few problems with the snowflakes currently available for DesktopX:

They don't actually look like snow. The flakes are too big - they may be nice representations, but they don't look realistic.
There aren't enough of them. Ten, or twenty, not two hundred or a thousand.
They don't act like snow. They fall down in a straight line at a constant velocity, possibly rotating - which leads to the next problem . . .
They can take up a heck of a lot of CPU all the time (especially if they try to look better by rotating). They don't have any big errors that make them do this, and it obviously isn't always the case, especially if you have just a few - but to make it look good, you need a lot. And this means that people have to choose between having a pretty desktop in the background and being able to do work. Not good.

Anyway, I decided to make my own!

Understanding the Problem

I'm a programmer, and I already had an inkling as to what one problem with current snowflakes was - taking a quick look at one, I could see that they relied on each snowflake having its own script and timer. This is a nice clean way to do it - it means you can clone the flakes (if you can catch them!) and the snowflake is generally self-contained, which makes it easy to understand. The only problem is that it is incredibly wasteful! Each snowflake needs its own timer, which (for technical reasons) means it needs its own window. The more windows you have, the more the whole system slows down.

To test this theory (always test your theories!) I cloned a bunch of snowflakes - about 30 to start with - and immediately ran into big problems. DesktopX had sucked up all the CPU! Talking with a few of my friends at Stardock, I discovered the reason; I wasn't running in IconX mode, and thus not only did each object have a timer window, it was also using a real (layered) window to paint itself onto the desktop. This was bad news for all sorts of reasons. Duly advised, I changed to IconX mode. You may wish to advise users of your scripts to do the same, if you create large numbers of objects.

Haivng done that, the amount of CPU time used by DesktopX suddenly became more reasonable, and so naturally I decided to be evil and clone a bunch more - 100 more, in fact - until I was once again at the CPU limit. I was actually quite impressed that it got this far, but I still wanted to find out what the limiting factor was, so I ran AMD's CodeAnalyst to see what was taking all the time. This program basically takes lots of snapshots of the computer's state, and so it can tell you what it was doing at the time.

Not exactly to my surprise, I found that DesktopX was spending a significant amount of time trying to draw all those objects to the screen. However, I also found it taking up almost 8% of the time just handling the timers - on my computer, that's over a hundred million cycles per second! There were also a few unexpected "hot points" in the code which I reported to the DesktopX development team.

Defining Objectives

With the above knowledge in hand, I was able to define the following objectives for my better snowflake objects:

Make the flakes look and act like real snow. Consider adding flurries and the like, but at the very least the flakes should not all be moving in the same direction at constant speeds.
Have changes in the "wind" now and again.
Have only one object controlling all of this to minimise scripting overhead.
Try to keep CPU usage within reasonable limits, or adjust to the amount being used already by slowing down flake update speed, reducing the number of flakes, or otherwise limiting the amount of CPU time they use.
Learn something!

Getting Down to Flakes

The original snowflake objects were quite large and complex. I didn't want that - real snow doesn't look like christmas-tree decorations! I therefore started with a very simple snowflake object - just a 5x5 alpha-blended white circular pixel! Amazingly enough, this proved very realistic, although I added 4x4 and 3x3 for a bit of variety. The snowflake controller can use any number of objects as flakes - to add one, just clone the last of the existing "GR_Snow_OriginalFlake_number" objects to get the next number in sequence.

The key to realism was in getting the snowflakes to move correctly. Moving down at a steady speed was not sufficient. A variety of techniques were used, but the base movement was derived from the description - but not the code

- of a Flash snowflake script by Kirupa Chinnathambi. This script provided the main algorithm of varying the x-position of the snowflake by a cosine wave, which proved quite successful. If you wish to see how I implemented this, look at the Class Flake's Sub Update() for details.

Trimming the Load

Given that this was meant to be a background object, I really wanted to reduce the CPU cost. Most programmers know that loops are where it really starts to hurt - if you want to improve performance, increase the speed of a loop by taking calculations outside of it. In my case, I noticed that I was checking System.WorkAreaBottom inside the main loop. This was a bad idea, because each time I accessed that property it would make an API call to check the workspace area.

Just by changing this call over to a global variable that I kept updated, I managed to trim 15-20% of the time spent in the VBScript libraries and half of the time spent in DesktopX's ActiveX host (the bit that provides the System object). That's an extra 10 or 20 snowflakes right there. I found I was using this method in other places too (mostly when repositioning the snowflakes after they fell off the screen), but the big gain was in removing this expensive call from the main repositioning loop. If you make objects, you might want to check this isn't happening in yours.

Other more modest gains were made in the same way. For example, to ensure that time was not wasted drawing snowflakes that fell off the screen, those that drifted a certain distance offscreen to the left or right were recycled. This meant that each time, the following statement was evaluated:

If y > VSCREEN_BOTTOM Or x > VSCREEN_RIGHT + 20 Or x < VSCREEN_LEFT - 20 Then . . .

Looks fine, right? However, I found that a small but significant proportion of time was taken in processing this line - in particular, the margin values. Removing this calculation from outside the loop replaced it with this:

If y > VSCREEN_BOTTOM Or x > VSCREEN_RIGHT_MARGIN Or x < VSCREEN_LEFT_MARGIN Then

which ended up making the script 3-4% faster overall. Not much, perhaps, but every little helps. I would later split this code up to add support for wind, but removing the redundant additions remained a benefit.

It is important to note that just because you think something is faster doesn't mean it will be. There were several cases where I thought something would be faster if done in one way, only to find out that the way it was before worked just as well; or worse, the new way was slower! Always test your theories with a standard test - this can be as simple as watching the CPU time in Task Manager while you run a loop 1000 times, or something a little more involved, like using CodeAnalyst - and if you do find a difference, double-check it!

Keeping it Smooth

Obviously, no matter how much I did to reduce overhead, there is some limit to how many flakes can be displayed onscreen, even if you have the very latest in harware; the snowflake script is essentially a fullscreen animation at 25+ FPS, which is hard enough when you have full control of the computer, let alone in GDI mode. What I wanted was a way to make sure that no matter what settings the user chose, the snowfall stayed relatively smooth and - more importantly - it didn't become too much of a burden on the user's computer. After all, a pretty desktop background is one thing, but if that gets in the way of a video chat to your parents, that's quite another thing!

The first thing I tried was using WMI. For those who haven't run into it before, WMI is the Windows Management Infrastructure - it contains lots of ways to measure and set various things, such as hard disk size, process priority levels and CPU usage. You may have been using it without knowing, through the System Performance Meters plugin.

My plan was to monitor DesktopX's CPU usage and do something if it got too high. I tried using WMI to do this both directly and through the plugin, and both times ran into problems. The plugin did not seem to give me the numbers I wanted, while calling WMI directly did . . . but at the same time, it caused a 5% CPU overhead (including a helper process that seemed to be servicing the requiests), which just made the problem worse!

After a bit of thinking, I decided to try a different approach. VBScript offers a Timer function that returns the number of seconds since midnight. However, it does so to a millisecond accuracy - or at least, 10ms - enough for me to use to measure how long it took to execute one of my flake updates. If this time was significantly longer than the time it was meant to take, I would know that the computer was lagged and that I should take some flakes away.

This approach eventually worked, but required a lot of tweaking to get working well. One problem was that the number of flakes tended to vary around the maximum level of flakes, when ideally we would want it to find that value quickly and stay there. To smooth this variation I introduced two threshold constants - one for how long past the timer interval the tick could go before allowing the addition of a new flake, and one for how long past before it was considered lagged (the first being lower than the second). These were multiples of the base tick time.

I also had two counters - one that measured how many ticks had gone by without being considered lagged, and one which measured the opposite. Once the algorithm was modified not to remove snowflakes before a certain number of lagged ticks had passed and (more importantly) not to add them back until a certain number of unlagged ticks had passed, things suddenly worked much better.

Drifting in the Breeze

I tried these flakes out with a few beta testers from #stardock IRC, but according to them they seemed to be missing a few things. The first was snow settling. This was relatively simple - just set a counter for each flake when it reached the bottom of the screen, and if the counter runs out, fade the flake away and reposition it.

A more interesting problem was wind. I planned on doing something rather complicated for this, but it turned out that a simple but effective solution to this was to just choose a direction and a magnitude, and have an addition to each flake's velocity that approached that linearly. To do this, I figured out the difference between the current wind and the future wind, chose a random time for the transition, and then sliced that up into chunks - so if we were starting from no wind at all, each update the wind's effect on the snowflakes would be a little stronger until it reached its full speed, at which point the wind would start changing to something else. This created a very realistic effect, as long as you weren't looking for a blizzard.

A couple of other things I had to think about were people resizing the taskbar or even changing resolution while using the object. The snowflakes had to adapt to this, which is where the Sub System_OnScreenChange and Sub System_OnWorkAreaChange (new in DX 2.4) came in. These subroutines are called for each object whenever the screen resolution or workspace area change, respectively, and can be useful for updating cached data.

Let it snow, let it snow, let it snow . . .

So, at the end, what do we have? Well, it's a pretty complicated widget to do what seems to be a pretty simple thing.

The most complicated work was done to ensure that the widget did not take too much CPU time from everything else, although making the snowflakes move in just the right way certainly adds to that. The majority of the time is taken by DX in moving the flake objects around, and by Windows in painting them. Perfect snow that is not interrupted is not really possible without increasing the priority of DesktopX (and so potentially starving other, more deserving apps of CPU time), but I think the solution presented in this article works well. Enjoy!

** PLEASE READ IMPORTANT NOTICES BEFORE DOWNLOADING FOR BEST EXPERIENCE **
Realistic Snowflakes by Laurence "GreenReaper" Parry - images by PixelPirate.
Bring the winter snows to your desktop! Features hundreds of swaying, wind-swept flakes floating in the background. User options - click the snowman to change - include maximum number of flakes (actual count is balanced for idle CPU use), flake interval (lower = faster), gravity and settle time on the bottom of your screen. Try the flakes out today - no need to wait for Christmas!

* PLEASE READ: You must hide desktop icons or be in IconX mode for best performance. This snow uses lots of objects, and these objects must be at desktop level to perform well. This will only work if you are hiding the desktop icons (this option is on the Theme tab when configuring DesktopX), or are in IconX mode. If you do not do this, expect high CPU usage and a low number of flakes. Sorry, that's just the way Windows XP works! Expect improvments in Longhorn.

* READ ALSO: This does not occur on all machines, but if you find DesktopX's user interface freezes up above a certain number of flakes, please terminate DesktopX via Task Manager (Ctrl+Alt+Del/Processes tab/right-click DesktopX.exe/End Process) and restart with a lower value for Max Flakes - it should restart with the previous session's settings, not the ones that locked up. This should not affect other programs, only DesktopX. Make sure you have the very latest version of DesktopX available as future updates may fix this.

Having said the above, do experiment with the settings to find the best level for your computer - the initial settings are conservative, particularly the Max Flake count. The snowflake script will automatically compensate for CPU usage by other programs by removing snowflakes when CPU use is high, and adding them back when it is low - you should be able to run this object in the background without trouble, although you might want to set it to 0 flakes while gaming.

Flakes are customizable - just clone another OriginalFlake or replace existing images. Text works too, try some floating Wingdings! You may also tweak certain variables in the script - see script comments. Many thanks to PixelPirate for creating the snowman and settings dialog images for this - all rights are reserved for these. You may use this script in your own objects as long as they are free to download - edit the snowman's script for details.

The wallpaper in this skin shot is available here.

** DID YOU READ THE INSTRUCTIONS BEFORE DOWNLOADING? Yes? Good. Download! [alternate download]

Locked Post

Advanced Search

Subscribe to this post

Do not email me updates for this post Email me updates for this post

Successfully updated karma reason!

gr, this snowflake object is superb. i know you've put many hours of work into it and it definitely shows in the finished product. thanks for sharing it with us.

Successfully updated karma reason!

Tiggz

Join Date 08/2003

+39

Fantastic article - very helpful and informative. As a self-taught dx scripter I have heaps of bad habits born out of ignorance, but articles like this go a long way to helping me understand some of the less obvious aspects of programming. Thanks alot for taking the time and trouble to share your expertise

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

It was a pleasure! I see a lot of scripts out there and it's just depressing sometimes how easy it would be to make them better, especially given the quality of the artwork displayed. Anything I can do to help that is well worth my time when you consider how many users are trying DesktopX nowdays - a little bit of knowledge and a few examples can go a long way.

Successfully updated karma reason!

Sign Up or Login and this ad disappears!
There are many great features available to you once you register. Sign Up for a free account and browse the forums without ads.

Superb work. Thanks so much for sharing this. This is just a great object, and a fantastic article as well.

Successfully updated karma reason!

This is great....which line in the script do you change to change the number of snowflakes?

Successfully updated karma reason!

Well, can you now tell us how to get rid of your Snowflakes? We have done everything possible with our tools to rid them...but they apparently want to stay with us forever! Thanks!

angels_are_real2@msn.com

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

Well, you could click the snowman and turn max flakes down to zero, delete the object or just make a new theme. They won't last beyond that.

Or go to C:\Documents and Settings\{your username here}\Local Settings\Application Data\Stardock\DesktopX\CurrentTheme and kill the files starting with "{FAAB1BF4 . . .". That should do it. May be C:\Program Files\Stardock\Object Desktop\DesktopX\{your username here}Theme\ for older versions of DX.

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

Essencay: Just click the snowman! There is a maximum flakes setting, along with others. As for inside the script, the max flakes setting is MAX_FLAKES, the current level is CurrentFlakes, and the target level (what it's working its way up/down to) is TargetFlakes.

Successfully updated karma reason!

werewolf

Join Date 04/2001

+28

Fantastic. This really works very well and scripting lesson above, and the documentation in the script is a big help and a great lesson. Thanks so much for all this. You should consider posting this article on the main page.

Successfully updated karma reason!

paxx

Join Date 03/2001

Very interesting article. Loads to learn from there.
Unfortunately, my current computer doesn't like it. The best I could get from this object is having it use 25% of my CPU, and that's with only 50 flakes refreshing at 30ms. If I try going to 100 flakes, it jumps to 95% of CPU...
Too bad, cause it looks cool.

Successfully updated karma reason!

Thanks for writing this article, it's going to help out alot on learning DesktopX.

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

paxx: Well, that may be all your computer can do - what's the specs? Mine only does 150 at once when hiding icons (110 in IconX mode!), unless I let them settle, as settled flakes take up far less CPU time (don't have to move). It's an Athlon XP 1700+. However, it shouldn't get in your way, the flake count should cut back if you actually have to use any of that CPU in other programs. If it is not then something's messed up (could be running into the aforementioned DX bug).

Successfully updated karma reason!

Had to use Object Navigator w/right click delete to remove them as all else failed. Wow, what an experience that was. Never had too much luck with any snowflakes and CPU usage.

Successfully updated karma reason!

Green already knows how much I like this. I have been bugging him since he started it lol. This is the best one yet, the wind addition makes a great difference. Looks fantastic.

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

Firedogs: I'll be chatting to the DX developers about that, then. There is a specific problem with the way DesktopX processes events that causes the user interface to freeze up, and I'm hoping there's a way it can be changed so that it doesn't.

Successfully updated karma reason!

you know you could also override your computer to take in more data but i think its illegal now

Successfully updated karma reason!

i have no idea what you guys are talking about with the script i mean i know what the script is but i dont know how to use it or customize it

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

timmy: Well, if you have DesktopX you can use it just by clicking the Download link at the bottom of the article. Make sure you are hiding desktop icons in DesktopX, or using IconX mode if you have that installed (you will get fewer flakes, though). Click the snowman for options.

Successfully updated karma reason!

I don't know how to use the download, It just is a file full of scripts and pictures, call me stupid but I don't know how to use it if it doesn't have an 'install' button

Successfully updated karma reason!

ANy help would be appreciated for this particular uninitiated

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

Ah. The download should be a .dxpack file. If you find it downloads as a zip because of IE's security "fixes", right-click the download link and save it as a .dxpack file, then double-click it, or alternatively start DesktopX (which you need to use it - http://www.desktopx.net/ ), right-click the tray icon that appears, select Import/Browse..., and browse to the saved file from the window that pops up - if it's a zip, you may need to put * in for filename and press enter first, as that is not a recognized extension.

Successfully updated karma reason!

Thank you for your reply GreenReaper. By-the-way, congratulations for creating another style of snow. We're using the Beta of DesktopX; not sure if this has any bearing. I doubt it though. A problem we have had with other objects (not to our liking after download)is deleting them using the "Delete" button within "Select object" (DesktopX-Settings/Import an object/Select object). Some will not delete from storage as they should. Absent this Stardock believed problem, we've never had any CPU problem with objects, and one object we are presently using is quite large...Ktecdockv1 by Tiggz.

Successfully updated karma reason!

GreenReaper

Join Date 05/2001

+27

It's not so much the largeness as much as the moving 100 of them 25 times a second-ness that causes the CPU problems.

As for deleting from storage, you could probably go into Program Files\Stardock\Object Desktop\DesktopX\Objects and delete them from there.

Successfully updated karma reason!

This is an excellent article and a great widget to go with it - Good job Green

Now wasn't this what Brad was asking for when he went on about original thinking for DX objects?

Successfully updated karma reason!

is there any other way to get the wall? All I'm getting is blank.png or a blank untitled.bmp.TIA

Successfully updated karma reason!

Welcome Guest! Please take the time to register with us.

There are many great features available to you once you register, including:

Richer content, access to many features that are disabled for guests like commenting and posting on the forums.
Access to a great community, with a massive database of many, many areas of interest.
Access to contests & subscription offers like exclusive emails.
It's simple, and FREE!

View all recent posts

Mark all posts as read Delete cookies created by the forum Return to Top

Stardock Forums v1.0.0.0 #108499 web02 Server Load Time: 00:00:00.0000235 Page Render Time: