package brr

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Render buffer dimensions
Contexts
Converting

brr
- Brr
  - Abort
    
    Signal
  - At
    
    Name
  - Base64
  - Blob
    
    Ending_type
  - Console
  - Document
    
    Visibility_state
  - El
    
    Input
    
    Name
    
    Navigation_ui
    
    Prop
    
    Style
  - Ev
    
    Clipboard
    
    Composition
    
    Data_transfer
    
    Effect
    
    Item
    
    Kind
    
    Item_list
    
    Drag
    
    Error
    
    Extendable
    
    Focus
    
    Hash_change
    
    Input
    
    Keyboard
    
    Location
    
    Mouse
    
    Pointer
    
    Type
    
    Wheel
    
    Delta_mode
  - File
  - G
  - Json
  - Navigator
  - Performance
    
    Entry
    
    Navigation_timing
    
    Type
    
    Resource_timing
    
    Type
  - Tarray
    
    Buffer
    
    Data_view
  - Uri
    
    Params
  - Window
    
    History
    
    Ev
    
    Popstate
    
    Scroll_restoration
- Brr_canvas
  - C2d
    
    Composite_op
    
    Fill_rule
    
    Image_data
    
    Image_smoothing_quality
    
    Line_cap
    
    Line_join
    
    Path
    
    Repeat
    
    Text_align
    
    Text_baseline
    
    Text_direction
    
    Text_metrics
  - Canvas
  - Gl
    
    Active_info
    
    Attrs
    
    Power_preference
    
    Shader_precision_format
    
    Tex_image_source
  - Matrix4
  - Vec4
- Brr_io
  - Clipboard
    
    Item
    
    Presentation_style
  - Fetch
    
    Body
    
    Cache
    
    Storage
    
    Ev
    
    Headers
    
    Request
    
    Cache
    
    Credentials
    
    Destination
    
    Mode
    
    Redirect
    
    Response
    
    Type
  - Form
    
    Data
    
    Ev
    
    Data
    
    Submit
  - Geolocation
    
    Error
    
    Pos
  - Media
    
    Capabilities
    
    Constraints
    
    Device
    
    Info
    
    Kind
    
    Devices
    
    Ev
    
    El
    
    Audio_track
    
    List
    
    Can_play
    
    Cors
    
    Error
    
    Have
    
    Network
    
    Provider
    
    Text_track
    
    Kind
    
    List
    
    Time_ranges
    
    Video_track
    
    List
    
    Prop
    
    Bool
    
    Constraint
    
    Float
    
    Constraint
    
    Range
    
    Int
    
    Constraint
    
    Range
    
    Jstr
    
    Constraint
    
    Recorder
    
    Bitrate_mode
    
    Ev
    
    Blob
    
    Error
    
    Recording_state
    
    Settings
    
    Stream
    
    Constraints
    
    Ev
    
    Supported_constraints
    
    Track
    
    Ev
    
    Kind
    
    Prop
    
    State
  - Message
    
    Broadcast_channel
    
    Channel
    
    Ev
    
    Port
  - Notification
    
    Action
    
    Direction
    
    Ev
    
    Permission
  - Storage
    
    Ev
  - Websocket
    
    Binary_type
    
    Ev
    
    Close
    
    Ready_state
- Brr_webaudio
  - Audio
    
    Buffer
    
    Context
    
    Base
    
    Latency_category
    
    Offline
    
    State
    
    Listener
    
    Node
    
    Analyser
    
    Biquad_filter
    
    Type
    
    Buffer_source
    
    Channel_count_mode
    
    Channel_interpretation
    
    Channel_merger
    
    Channel_splitter
    
    Constant_source
    
    Convolver
    
    Delay
    
    Destination
    
    Dynamics_compressor
    
    Gain
    
    Iir_filter
    
    Media_element_source
    
    Media_stream_destination
    
    Media_stream_source
    
    Media_stream_track_source
    
    Oscillator
    
    Periodic_wave
    
    Type
    
    Panner
    
    Distance_model
    
    Panning_model
    
    Stereo_panner
    
    Wave_shaper
    
    Oversample
    
    Worklet
    
    Param
    
    Automation_rate
    
    Timestamp
    
    Worklet
    
    G
    
    Processor
- Brr_webcrypto
- Brr_webworkers
  - Service_worker
    
    Client
    
    Frame_type
    
    Type
    
    Visibility_state
    
    Window
    
    Clients
    
    Container
    
    G
    
    Navigation_preload_manager
    
    Registration
    
    State
    
    Update_via_cache
  - Worker
    
    G
    
    Shared
    
    Type
- Fut
  - Result_syntax
  - Syntax
- Jstr
- Jv
  - Bool
  - CONV
  - Error
  - Float
  - Id
  - Int
  - It
  - Jarray
  - Jstr
  - Promise
brr.note
- Brr_note
  - Consoler
    
    E
    
    S
  - Elr
  - Evr
  - Futr
- Brr_note_kit
  - Human
  - Key
  - Mouse
    
    Cursor
  - Time
  - Ui
    
    Button
    
    Float_selector
    
    Group
    
    Jstr_editor
    
    Label
    
    Value_selector
    
    Button
    
    Menu
  - Windowr
- Brr_note_legacy
  - Store
brr.ocaml_poke
- Brr_ocaml_poke
brr.ocaml_poke_ui
- Brr_ocaml_poke_ui
  - History
  - Store
brr.poke
- Brr_poke
brr.poked
- Brr_poked

Legend:
Library
Module
Module type
Parameter
Class
Class type

Canvas element.

type t

The type for HTMLCanvasElement objects.

val create : 
  ?d:Brr.Document.t ->
  ?at:Brr.At.t list ->
  ?w:int ->
  ?h:int ->
  Brr.El.t list ->
  t

create ~w ~h [] is a canvas element with a render buffer of wxh pixels (they default to 0).

val of_el : Brr.El.t -> t

of_el e is a canvas from element e. This throws a JavaScript error if e is not a canvas element.

val to_el : t -> Brr.El.t

to_el c is c as an an element.

Render buffer dimensions

val w : t -> int

w c is the render buffer width of c in pixels.

val h : t -> int

h c is the render buffer height of c in pixels.

val set_w : t -> int -> unit

set_w c w sets the render buffer width of c to w pixels.

val set_h : t -> int -> unit

set_h c h sets the render buffer height of c to h pixels.

val set_size_to_layout_size : ?hidpi:bool -> t -> unit

set_size_to_layout_size t sets the render buffer size to the canvas' element Brr.El.inner_w Brr.El.inner_h and values. If hidpi is true (defaults), these values are multiplied by Brr.Window.device_pixel_ratio.

Contexts

Context are created by the modules that handle them.

For the 2D context see C2d.create.
For the WebGL2 context see Gl.create.

Converting

type image_encode

The type for image encode parameters.

val image_encode : ?type':Jstr.t -> ?quality:float -> unit -> image_encode

image_encode ~type' ~quality () are image encoding parameters type' is the mime type of the image, it defaults to "image/png". quality a number from 0. to 1. if it makes sense for the data format (e.g. JPEG), default is implementation dependent.

val to_data_url : 
  ?encode:image_encode ->
  t ->
  (Jstr.t, Jv.Error.t) Stdlib.result

to_data_url ~encode t is the canvas's image as a data url.

val to_blob : ?encode:image_encode -> t -> Brr.Blob.t option Fut.or_error

to_blob ~encode t is the canvas's image a blob object. None is returned either if the canvas has no pixels or if an error occurs during image serialisation.

val capture_stream : hz:int option -> t -> Brr_io.Media.Stream.t

capture_stream ~hz is a capture media stream for the canvas at the frequency of hz or manually if unspecified.