package bogue

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Dependency graph

package bogue

bogue
- Bogue
  - Avar
  - Box
  - Button
  - Check
  - Draw
  - Image
  - Label
  - Layout
  - Long_list
  - Main
  - Menu
  - Mixer
  - Mouse
  - Popup
  - Print
  - Radiolist
  - Sdl_area
  - Select
  - Selection
  - Slider
  - Snapshot
  - Space
  - Style
  - Sync
  - Table
  - Tabs
  - Text_display
  - Text_input
  - Theme
  - Time
  - Timeout
  - Trigger
  - Tvar
  - Update
  - Utils
  - Var
  - Widget
  - Window

Legend:
Library
Module
Module type
Parameter
Class
Class type

Image widget

Dependency graph

type t

val create : 
  ?width:int ->
  ?height:int ->
  ?noscale:bool ->
  ?bg:Draw.color ->
  string ->
  t

create "image.jpg" will load the image "image.jpg". The actual load occurs only once, on the first time the image widget is effectively displayed. The image is then stored in a texture. All Sdl_image image formats are supported.

The file "image.png" will be search in the current Theme directory. Absolute paths starting with "/" can also be used.

parameter noscale
if true, the image will appear at the original hardware pixel size. By default, noscale=false and the image is scaled using the Theme SCALE variable.

val create_from_svg : 
  ?width:int ->
  ?height:int ->
  ?bg:Draw.color ->
  string ->
  t

Load an svg image. This requires the rsvg or rsvg-convert program.

Remark: With SDL_Image >= 2.0.2, one can use create to load SVG files, but the size is not correctly handled (the image will be rendered at its 'internal SVG size', and then scaled, which may result in poor accuracy).