package sfml

You can search for identifiers within the package.

in-package search v0.2.0

package sfml

sfml
- Library sfml.audio
- Library sfml.audio_oo
  - Oo_sfml_audio
    
    music
    
    listener
    
    sound_buffer
    
    sound
- Library sfml.graphics
  - SFBlendMode
  - SFCircleShape
  - SFColor
  - SFFont
  - SFImage
  - SFRect
  - SFRectangleShape
  - SFRenderStates
  - SFRenderWindow
  - SFShader
  - SFShape
  - SFSprite
  - SFText
  - SFTexture
  - SFTransform
  - SFView
- Library sfml.graphics_oo
  - Oo_sfml_graphics
    
    int_rect
    
    float_rect
    
    image
    
    texture
    
    render_states
    
    drawable
    
    sprite
    
    shape
    
    circle_shape
    
    font
    
    text
    
    view
    
    render_window
- Library sfml.network
  - SFFtp
    
    Response
    
    ListingResponse
    
    DirectoryResponse
  - SFHttp
    
    Request
    
    Response
  - SFIpAddress
  - SFPacket
  - SFSocketSelector
  - SFTcpListener
  - SFTcpSocket
  - SFUdpSocket
- Library sfml.network_oo
  - Oo_sfml_network
    
    ip_address
    
    packet
    
    tcp_socket
    
    udp_socket
    
    http_request
    
    http_response
    
    http
    
    response
    
    directory_response
    
    listing_response
    
    ftp
- Library sfml.system
- Library sfml.system_oo
  - Oo_sfml_system
    
    time
    
    Time
    
    clock
    
    pausable_clock
- Library sfml.window
  - SFClipboard
  - SFContext
  - SFContextSettings
  - SFCursor
  - SFEvent
  - SFJoystick
  - SFKey
  - SFKeyboard
  - SFMouse
  - SFSensor
  - SFStyle
  - SFVideoMode
  - SFWindow
- Library sfml.window_oo
  - Oo_sfml_window
    
    window

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `SFBlendMode`

type factor =

| Zero
(*
(0, 0, 0, 0)
*)
| One
(*
(1, 1, 1, 1)
*)
| SrcColor
(*
(src.r, src.g, src.b, src.a)
*)
| OneMinusSrcColor
(*
(1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
*)
| DstColor
(*
(dst.r, dst.g, dst.b, dst.a)
*)
| OneMinusDstColor
(*
(1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
*)
| SrcAlpha
(*
(src.a, src.a, src.a, src.a)
*)
| OneMinusSrcAlpha
(*
(1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
*)
| DstAlpha
(*
(dst.a, dst.a, dst.a, dst.a)
*)
| OneMinusDstAlpha
(*
(1 1, 1, 1) - (dst.a, dst.a, dst.a, dst.a)
*)

Enumeration of the blending factors

The factors are mapped directly to their OpenGL equivalents, specified by glBlendFunc() or glBlendFuncSeparate().

type equation =

| Add
(*
Pixel = Src * SrcFactor + Dst * DstFactor
*)
| Subtract
(*
Pixel = Src * SrcFactor - Dst * DstFactor
*)
| ReverseSubtract
(*
Pixel = Dst * DstFactor - Src * SrcFactor
*)

Enumeration of the blending equations

The equations are mapped directly to their OpenGL equivalents, specified by glBlendEquation() or glBlendEquationSeparate().

type t = {

color_src_factor : factor;
(*
Source blending factor for the color channels
*)
color_dst_factor : factor;
(*
Destination blending factor for the color channels
*)
color_equation : equation;
(*
Blending equation for the color channels
*)
alpha_src_factor : factor;
(*
Source blending factor for the alpha channel
*)
alpha_dst_factor : factor;
(*
Destination blending factor for the alpha channel
*)
alpha_equation : equation;
(*
Blending equation for the alpha channel
*)

}

Blending modes for drawing

val make : ?equation:equation -> factor -> factor -> t

Construct the blend mode given the factors and equation.

This constructor uses the same factors and equation for both color and alpha components. It also defaults to the Add equation.

val alpha : t

Commonly used blending modes

Blend source and dest according to dest alpha

val add : t

Blend source and dest according to dest alpha

Add source to dest

val multiply : t

Add source to dest

Multiply source and dest

val none : t

Multiply source and dest

Overwrite dest with source

package sfml

Module SFBlendMode

Module `SFBlendMode`