Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiGenerateThumbnails

hiGenerateThumbnails(
?lib g_lib
[ ?cell g_cell ]
[ ?view g_view ]
[ ?sizes g_sizes ]
[ ?output g_output ]
[ ?verbose g_verbose ]
[ ?exportArgs g_exportArgs ]
[ ?filePath t_filePath ]
)
=> thumbnails / nil

Description

Generates thumbnails for given library cellviews. Function behavior depends on arguments provided. All arguments can be lists in order to batch-generate thumbnails for a series of libraries, cells, views and sizes. At present, only the default 128x128 thumbnail is used by Cadence tools.

Regular expressions and wildcards are not supported.

Arguments

?lib g_lib

The library that contains the cellviews to generate thumbnails for.

?cell g_cell

The cell that contains the cellviews to generate thumbnails for.

?view g_view

The cellview to generate a thumbnail for.

?sizes g_sizes

The size of the thumbnails to be generated. The g_sizes argument can be an integer, an integer pair, or a list of integers or integer pairs. Single integers are interpreted as both the width and height. To generate a 64x64 thumbnail, specify a size of either 64 or 64 64 as both are considered the same. If no size is supplied, then either all existing thumbnail resolutions gets updated, or a new thumbnail is created at the default resolution (currently 128x128).

?output g_output

Enter a symbol indicating where output should display. For example, the default 'progressbar uses the embedded CIW progress bar.

?verbose g_verbose

Set to print the name of the file which was saved to the CIW.

Default value: nil

?exportArgs g_exportArgs

  

Set to allow arguments to be passed to the underlying hiExportImage function, consequently allowing further customization of the generated thumbnails.

exportArgs takes a list of pairs (an association table), which are passed to hiExportImage. For any argument that you want to pass to the export image, via thumbnails, simply add the keyword and the argument into the list. For example, to generate grayscale thumbnails with a white background:

hiGenerateThumbnails(?lib mylib ?cell mycell ?view myview ?exportArgs list(list('colorType 'monochrome) list('bgColor "white") list('fgColor "black"))

?filePath t_filePath

  

Set to allow the location of the generated thumbnail to be customized.

filePath provides for a wide range of control over where a thumbnail file is generated:

  • For a simple string like "myDir", thumbnails gets generated hierarchically under that directory, for example: myDir/lib/cell/view/thumbnail_128x128.png.
  • If the string contains a '/', the thumbnail code creates the directory if necessary.
  • printf-style formatting strings can be used in the string. Currently supported are: %L (lib), %C (cell), %V (view), %W (width) and %H (height).
    These are all expanded at the time the thumbnail is generated.
  • The above features therefore allow the filename to be highly customized, such as:
?filePath "%L/%C/%V/%Wx%H/thumbnail.png", eg. "overview/follower/layout/128x128/thumbnail.png"
?filePath "%L_%C_%V-%Wx%H.png", eg. "overview_follower_layout-128x128.png"
?filePath "myThumbs/lib_%L/cell_%C/view_%V", eg. "myThumbs/lib_overview/cell_follower/view_layout/thumbnail_128x128.png
In the last example, the default filename is appended if no filename is presented.

Value Returned

thumbnails

Number of thumbnails successfully generated.

nil

Command failed.

Examples

Generates a thumbnail for the acpd/follower/layout view.

hiGenerateThumbnails( ?lib "acpd" ?cell "follower" ?view "layout")

Generates thumbnails for all supported cellview types in the acpd library.

hiGenerateThumbnails( ?lib "apcd" )

Generates thumbnails for all supported cellview types in the acpd and analogLib libraries.

hiGenerateThumbnails( ?lib ’("acpd" "analogLib"))

Generates thumbnails for all libraries that are writable.

hiGenerateThumbnails( ?lib ’AllWritable)

Generates, for each schematic and symbol view in the acpd library, the following series of thumbnails in the view directories: 64x64, 128x128, 256x256, 128x256.

hiGenerateThumbnails( ?lib "acpd" ?view ’("schematic" "symbol") ?sizes list(64 128 256 128:256)
hiGenerateThumbnails(?lib "ether" ?sizes list(1024))
The sizes argument is a list of either pairs or numbers. Pairs are interpreted as the width and height, single numbers are interpreted as being both the width and the height (hence it is sufficient to just pass 1024 above, rather than (1024:1024). If you required a different height and width, you could use ?sizes list(1024:512).

Related Topics

Thumbnail View Functions

hiGetDefaultThumbnailResolution

hiGetThumbnailFilename

hiGetDefaultThumbnail


Return to top
 ⠀
X