Memory management - controls and popups

[JavaWiz]

Sub-

Couple questions about memory management:

1) What is the difference between skinHelper2.DisposeResources()
and PluginHelperFactory.getPluginHelper().DisposeResources(disposeList) ?

Should both be called in the Dispose method of each control instance?

2) Should the control's Dispose() call element.image.Dispose(), or does the call to the PluginHelper.DisposeResources do that under the covers. (see example below)

3) It looks like the UiButton.Dispose() method is empty. Shouldn't it call the PluginHelper dispose with the normal and selected UIElements?

Currently all the WizControls call the xxx.image.Dispose() method for each GBPVRUiElement object in the control as well as calling the PluginHelper dispose method at the end of the controls Dispose() routine.

For example, here is the dispose method for the text box:

Code:

[COLOR=black][SIZE=2]public [/SIZE][SIZE=2]override [/SIZE][SIZE=2]void[/SIZE][SIZE=2] Dispose()[/SIZE][/COLOR]
[SIZE=2][COLOR=black]{[/COLOR][/SIZE]
[SIZE=2][COLOR=black]  WizInfo.LogMessage("WizUiTextBox", "Dispose()", "Called for " + this.PlacementName);[/COLOR][/SIZE]
[COLOR=black][SIZE=2]  mRenderingRequired = [/SIZE][SIZE=2]false[/SIZE][SIZE=2];[/SIZE][/COLOR]
[COLOR=black][SIZE=2]  ArrayList[/SIZE][SIZE=2] disposeList = [/SIZE][SIZE=2]new[/SIZE][SIZE=2]ArrayList[/SIZE][SIZE=2]();[/SIZE][/COLOR]
[COLOR=black][SIZE=2]  if[/SIZE][SIZE=2] ([/SIZE][SIZE=2]this[/SIZE][SIZE=2].normalUiElement != [/SIZE][SIZE=2]null[/SIZE][SIZE=2])[/SIZE][/COLOR]
[COLOR=black][SIZE=2]      this[/SIZE][SIZE=2].normalUiElement.image.Dispose();[/SIZE][SIZE=2] disposeList.Add([/SIZE][SIZE=2]this[/SIZE][SIZE=2].normalUiElement);[/SIZE][/COLOR]

[COLOR=black][SIZE=2]   if[/SIZE][SIZE=2] ([/SIZE][SIZE=2]this[/SIZE][SIZE=2].selectedUiElement != [/SIZE][SIZE=2]null[/SIZE][SIZE=2])[/SIZE][/COLOR]
[SIZE=2][COLOR=black]   {[/COLOR][/SIZE]
[COLOR=black][SIZE=2]       this[/SIZE][SIZE=2].selectedUiElement.image.Dispose();[/SIZE][/COLOR]
[COLOR=black][SIZE=2]       disposeList.Add([/SIZE][SIZE=2]this[/SIZE][SIZE=2].selectedUiElement);[/SIZE][/COLOR]
[SIZE=2][COLOR=black]   }[/COLOR][/SIZE]
[COLOR=black][SIZE=2]   PluginHelperFactory[/SIZE][SIZE=2].getPluginHelper().DisposeResources(disposeList);[/SIZE][/COLOR]
[COLOR=black][SIZE=2]   normalUiElement = [/SIZE][SIZE=2]null[/SIZE][SIZE=2];[/SIZE][/COLOR]
[COLOR=black][SIZE=2]   selectedUiElement = [/SIZE][SIZE=2]null[/SIZE][SIZE=2];[/SIZE][/COLOR]
[SIZE=2][COLOR=black]}[/COLOR][/SIZE]

Is that the proper way to dispose of the objects?

[sub]

Sorry, I saw your other post the other day but it was late in the day and I was lacking the energy to respond

Sub-

Couple questions about memory management:

1) What is the difference between skinHelper2.DisposeResources()
and PluginHelperFactory.getPluginHelper().DisposeResources(disposeList) ?

You call PluginHelperFactory[SIZE=2].getPluginHelper().DisposeResources(disposeList) passing a list of any GBPVRUiElements you've manually created. These GBPVRUiElements have video texture memory associated with them, so making this call gives the framework a chance to free up that texture memory.[/SIZE]

skinHelper2.DisposeResources() tells the skinHelper to release extra resource it has cached. It doesnt hold any GBPVRUiElements objects, but it does have a cache of GDI resources like bitmaps/colours/fonts/brushes etc. Calling DisposeResources() tells the skin helper it can empty those caches and dispose of those item. This isnt strictly required, particularly if your plugin has released it reference to the skinhelper, since the unused objects will eventually be garbage collected by .net. Because cached bitmaps can be large though, it is probably advisable to call this method when closing a popup. Normal plugins screens (not popups) dont really need to bother since its fine to cache the resources until the app closes.

Should both be called in the Dispose method of each control instance?

Yes, if you've created a control manually (rather than having it created automatically using one of the supplied base classes, then you should call Dispose() on those controls. Behind the scenes this method on the controls, will construct the list of all its GBPVRUiElements it holds, and pass then to PluginHelperFactory[SIZE=2].getPluginHelper().DisposeResources(disposeList).[/SIZE]

2) Should the control's Dispose() call element.image.Dispose(), or does the call to the PluginHelper.DisposeResources do that under the covers. (see example below)

The framework will call element.image.Dispose() on all objects submitted via PluginHelperFactory[SIZE=2].getPluginHelper().DisposeResources(disposeList).[/SIZE]

3) It looks like the UiButton.Dispose() method is empty. Shouldn't it call the PluginHelper dispose with the normal and selected UIElements?

Yes, it should do, but isnt currently. I'll make sure this is added for the next release.

Currently all the WizControls call the xxx.image.Dispose() method for each GBPVRUiElement object in the control as well as calling the PluginHelper dispose method at the end of the controls Dispose() routine.

For example, here is the dispose method for the text box:

Code:

[COLOR=black][SIZE=2]public [/SIZE][SIZE=2]override [/SIZE][SIZE=2]void[/SIZE][SIZE=2] Dispose()[/SIZE][/COLOR]
[SIZE=2][COLOR=black]{[/COLOR][/SIZE]
[SIZE=2][COLOR=black] WizInfo.LogMessage("WizUiTextBox", "Dispose()", "Called for " + this.PlacementName);[/COLOR][/SIZE]
[COLOR=black][SIZE=2] mRenderingRequired = [/SIZE][SIZE=2]false[/SIZE][SIZE=2];[/SIZE][/COLOR]
[COLOR=black][SIZE=2] ArrayList[/SIZE][SIZE=2] disposeList = [/SIZE][SIZE=2]new[/SIZE][SIZE=2]ArrayList[/SIZE][SIZE=2]();[/SIZE][/COLOR]
[COLOR=black][SIZE=2] if[/SIZE][SIZE=2] ([/SIZE][SIZE=2]this[/SIZE][SIZE=2].normalUiElement != [/SIZE][SIZE=2]null[/SIZE][SIZE=2])[/SIZE][/COLOR]
[COLOR=black][SIZE=2]     this[/SIZE][SIZE=2].normalUiElement.image.Dispose();[/SIZE][SIZE=2] disposeList.Add([/SIZE][SIZE=2]this[/SIZE][SIZE=2].normalUiElement);[/SIZE][/COLOR]

[COLOR=black][SIZE=2]  if[/SIZE][SIZE=2] ([/SIZE][SIZE=2]this[/SIZE][SIZE=2].selectedUiElement != [/SIZE][SIZE=2]null[/SIZE][SIZE=2])[/SIZE][/COLOR]
[SIZE=2][COLOR=black]  {[/COLOR][/SIZE]
[COLOR=black][SIZE=2]      this[/SIZE][SIZE=2].selectedUiElement.image.Dispose();[/SIZE][/COLOR]
[COLOR=black][SIZE=2]      disposeList.Add([/SIZE][SIZE=2]this[/SIZE][SIZE=2].selectedUiElement);[/SIZE][/COLOR]
[SIZE=2][COLOR=black]  }[/COLOR][/SIZE]
[COLOR=black][SIZE=2]  PluginHelperFactory[/SIZE][SIZE=2].getPluginHelper().DisposeResources(disposeList);[/SIZE][/COLOR]
[COLOR=black][SIZE=2]  normalUiElement = [/SIZE][SIZE=2]null[/SIZE][SIZE=2];[/SIZE][/COLOR]
[COLOR=black][SIZE=2]  selectedUiElement = [/SIZE][SIZE=2]null[/SIZE][SIZE=2];[/SIZE][/COLOR]
[SIZE=2][COLOR=black]}[/COLOR][/SIZE]

Is that the proper way to dispose of the objects?

You dont need to worry about the element.image.Dispose(), but other than that it looks about right.

[JavaWiz]

Excellent. Thanks for the info...