hiGetThumbnailFilename

hiGetThumbnailFilename(
[ ?size g_size ]
)
=> s_filename / nil

Description

Returns the name of a thumbnail file for a given resolution. If no specific size is requested, the filename for the default thumbnail resolution is used (as set by hiGetThumbnailDefaultResolution).

The hiGetThumbnailFilename function does not check for the existence of the thumbnail, rather it instructs applications which file to look for in the view directory for a given resolution.

Argument

?size g_size

Optional argument that can be either a single integer (indicating a thumbnail with the same width and height) or a list of two integers specifying the thumbnail width and height. If the size argument is not supplied, it defaults to the return value from hiGetDefaultThumbnailResolution.

Value Returned

s_filename	Name of thumbnail file returned.
nil	No thumbnail file found.

Example

hiGetThumbnailFilename()

=> "thumbnail_128x128.png"

hiGetThumbnailFilename( ?size 256)

=> "thumbnail_256x256.png"

hiGetThumbnailFilename( ?size 128:256)

=> "thumbnail_128x256.png"

Related Topics

Thumbnail View Functions

hiGenerateThumbnails

hiGetDefaultThumbnail

hiGetDefaultThumbnailResolution

Return to top