BrightSign Object Reference Manual (FW 5.1) - Manual (Page 78)

70
• PreloadFile(image_filename As String) As Boolean: Loads the specified image file into an offscreen
memory buffer.
• PreloadFile(parameters As roAssociativeArray) As Boolean: Loads an image file into an offscreen
memrory buffer. Image display properties are determined by an associative array of parameters:
o Filename
o Mode: See the entry for SetDefaultMode() below for more details.
o Transition: See the entry for SetDefaultTransition() below for more details.
• DisplayPreload() As Boolean: Uses the on-screen memory buffer to display the image stored in the
offscreen memory buffer using
PreloadFile(). There are only two memory buffers: one is displayed on screen;
and the other is used for preloading images. PreloadFile() can be called multiple times before
DisplayPreload() is called, and will keep loading into the same off-screen buffer. The DisplayFile()
method calls
PreloadFile() followed immediately by DisplayPreload(), so any previously preloaded image
will be lost. If no image is preloaded, DisplayPreload() will have no effect.
• StopDisplay() As Boolean: Removes an image from the display.
• DisplayFileEx(filename As String, mode As Integer, x As Integer, y As Integer) As
Boolean
• PreloadFileEx(filename As String, mode As Integer, x As Integer, y As Integer) As
Boolean
• SetDefaultMode(mode As Integer) As Boolean: Sets the default image display mode for
DisplayFile() and PreloadFile(). If SetDefaultMode() is not called, then the default mode is set to 0
(equivalent to the image being centered without scaling). The supported display mode are listed below:
o 0 - Center image: No scaling takes place. Cropping only occurs if the image is bigger than the screen.
o 1 - Scale to fit: The image is scaled so that it is fully viewable, with its aspect ratio maintained.
o 2 - Scale to fill and crop: The image is scaled so that it completely fills the screen, with its aspect ratio
maintained.
o 3 - Scale to fill: The image is stretched so that it fills the screen and the whole image is viewable. This
means that the aspect ratio will not be maintained if it is different to that of the current screen resolution.