sdl3-bindgen-sys
Safe HaskellNone
LanguageGHC2021

SDL3.Sys.Bindgen.Blendmode

Description

Blend modes decide how two colors will mix together. There are both standard modes for basic needs and a means to create custom modes, dictating what sort of math to do on what color components. A set of blend modes used in drawing operations.

These predefined blend modes are supported everywhere.

Additional values may be obtained from SDL_ComposeCustomBlendMode.

See also
sDL_ComposeCustomBlendMode

Since: 3.2.0

Synopsis

Documentation

newtype SDL_BlendMode Source #

C declaration
SDL_BlendMode, defined at SDL3/SDL_blendmode.h 52:16

Constructors

SDL_BlendMode 

Fields

Instances

Instances details
Bits SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

FiniteBits SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Bounded SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Enum SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Storable SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Generic SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type Rep SDL_BlendMode 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendMode = D1 ('MetaData "SDL_BlendMode" "SDL3.Sys.Bindgen.Blendmode" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_BlendMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))
Ix SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Num SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Read SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Integral SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Real SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Show SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Eq SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Ord SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Prim SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

HasFFIType SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type FFIType SDL_BlendMode 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

ReadRaw SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

StaticSize SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

WriteRaw SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Bitfield SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

HasCField SDL_BlendMode "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type CFieldType SDL_BlendMode "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

offset# :: Proxy# SDL_BlendMode -> Proxy# "unwrap" -> Int #

ty ~ Uint32 => HasField "unwrap" SDL_BlendMode ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

hasField :: SDL_BlendMode -> (ty -> SDL_BlendMode, ty) #

ty ~ Uint32 => HasField "unwrap" (Ptr SDL_BlendMode) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

getField :: Ptr SDL_BlendMode -> Ptr ty #

type Rep SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendMode = D1 ('MetaData "SDL_BlendMode" "SDL3.Sys.Bindgen.Blendmode" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_BlendMode" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))
type FFIType SDL_BlendMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type CFieldType SDL_BlendMode "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

sDL_BLENDMODE_NONE :: CUInt Source #

no blending: dstRGBA = srcRGBA

C declaration
macro SDL_BLENDMODE_NONE, defined at SDL3/SDL_blendmode.h 54:9

sDL_BLENDMODE_BLEND :: CUInt Source #

alpha blending: dstRGB = (srcRGB * srcA) + (dstRGB * (1-srcA)), dstA = srcA + (dstA * (1-srcA))

C declaration
macro SDL_BLENDMODE_BLEND, defined at SDL3/SDL_blendmode.h 55:9

sDL_BLENDMODE_BLEND_PREMULTIPLIED :: CUInt Source #

pre-multiplied alpha blending: dstRGBA = srcRGBA + (dstRGBA * (1-srcA))

C declaration
macro SDL_BLENDMODE_BLEND_PREMULTIPLIED, defined at SDL3/SDL_blendmode.h 56:9

sDL_BLENDMODE_ADD :: CUInt Source #

additive blending: dstRGB = (srcRGB * srcA) + dstRGB, dstA = dstA

C declaration
macro SDL_BLENDMODE_ADD, defined at SDL3/SDL_blendmode.h 57:9

sDL_BLENDMODE_ADD_PREMULTIPLIED :: CUInt Source #

pre-multiplied additive blending: dstRGB = srcRGB + dstRGB, dstA = dstA

C declaration
macro SDL_BLENDMODE_ADD_PREMULTIPLIED, defined at SDL3/SDL_blendmode.h 58:9

sDL_BLENDMODE_MOD :: CUInt Source #

color modulate: dstRGB = srcRGB * dstRGB, dstA = dstA

C declaration
macro SDL_BLENDMODE_MOD, defined at SDL3/SDL_blendmode.h 59:9

sDL_BLENDMODE_MUL :: CUInt Source #

color multiply: dstRGB = (srcRGB * dstRGB) + (dstRGB * (1-srcA)), dstA = dstA

C declaration
macro SDL_BLENDMODE_MUL, defined at SDL3/SDL_blendmode.h 60:9

sDL_BLENDMODE_INVALID :: CUInt Source #

C declaration
macro SDL_BLENDMODE_INVALID, defined at SDL3/SDL_blendmode.h 61:9

newtype SDL_BlendOperation Source #

The blend operation used when combining source and destination pixel components.

C declaration
enum SDL_BlendOperation, defined at SDL3/SDL_blendmode.h 69:14

Since: 3.2.0

Constructors

SDL_BlendOperation 

Fields

Instances

Instances details
Storable SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Generic SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type Rep SDL_BlendOperation 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendOperation = D1 ('MetaData "SDL_BlendOperation" "SDL3.Sys.Bindgen.Blendmode" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_BlendOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
Read SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Show SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Eq SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Ord SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Prim SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

CEnum SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type CEnumZ SDL_BlendOperation 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

SequentialCEnum SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

HasFFIType SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type FFIType SDL_BlendOperation 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

ReadRaw SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

StaticSize SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

WriteRaw SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

HasCField SDL_BlendOperation "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type CFieldType SDL_BlendOperation "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

offset# :: Proxy# SDL_BlendOperation -> Proxy# "unwrap" -> Int #

ty ~ CUInt => HasField "unwrap" SDL_BlendOperation ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

ty ~ CUInt => HasField "unwrap" (Ptr SDL_BlendOperation) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendOperation = D1 ('MetaData "SDL_BlendOperation" "SDL3.Sys.Bindgen.Blendmode" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_BlendOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
type CEnumZ SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type FFIType SDL_BlendOperation Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type CFieldType SDL_BlendOperation "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

pattern SDL_BLENDOPERATION_ADD :: SDL_BlendOperation Source #

dst + src: supported by all renderers

C declaration
SDL_BLENDOPERATION_ADD, defined at SDL3/SDL_blendmode.h 71:5

pattern SDL_BLENDOPERATION_SUBTRACT :: SDL_BlendOperation Source #

src - dst : supported by D3D, OpenGL, OpenGLES, and Vulkan

C declaration
SDL_BLENDOPERATION_SUBTRACT, defined at SDL3/SDL_blendmode.h 72:5

pattern SDL_BLENDOPERATION_REV_SUBTRACT :: SDL_BlendOperation Source #

dst - src : supported by D3D, OpenGL, OpenGLES, and Vulkan

C declaration
SDL_BLENDOPERATION_REV_SUBTRACT, defined at SDL3/SDL_blendmode.h 73:5

pattern SDL_BLENDOPERATION_MINIMUM :: SDL_BlendOperation Source #

min(dst, src) : supported by D3D, OpenGL, OpenGLES, and Vulkan

C declaration
SDL_BLENDOPERATION_MINIMUM, defined at SDL3/SDL_blendmode.h 74:5

pattern SDL_BLENDOPERATION_MAXIMUM :: SDL_BlendOperation Source #

max(dst, src) : supported by D3D, OpenGL, OpenGLES, and Vulkan

C declaration
SDL_BLENDOPERATION_MAXIMUM, defined at SDL3/SDL_blendmode.h 75:5

newtype SDL_BlendFactor Source #

The normalized factor used to multiply pixel components.

The blend factors are multiplied with the pixels from a drawing operation (src) and the pixels from the render target (dst) before the blend operation. The comma-separated factors listed above are always applied in the component order red, green, blue, and alpha.

C declaration
enum SDL_BlendFactor, defined at SDL3/SDL_blendmode.h 88:14

Since: 3.2.0

Constructors

SDL_BlendFactor 

Fields

Instances

Instances details
Storable SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Generic SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type Rep SDL_BlendFactor 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendFactor = D1 ('MetaData "SDL_BlendFactor" "SDL3.Sys.Bindgen.Blendmode" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_BlendFactor" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
Read SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Show SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Eq SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Ord SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Prim SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

CEnum SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type CEnumZ SDL_BlendFactor 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

SequentialCEnum SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

HasFFIType SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type FFIType SDL_BlendFactor 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

ReadRaw SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

StaticSize SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

WriteRaw SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

HasCField SDL_BlendFactor "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Associated Types

type CFieldType SDL_BlendFactor "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

offset# :: Proxy# SDL_BlendFactor -> Proxy# "unwrap" -> Int #

ty ~ CUInt => HasField "unwrap" SDL_BlendFactor ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

hasField :: SDL_BlendFactor -> (ty -> SDL_BlendFactor, ty) #

ty ~ CUInt => HasField "unwrap" (Ptr SDL_BlendFactor) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

Methods

getField :: Ptr SDL_BlendFactor -> Ptr ty #

type Rep SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type Rep SDL_BlendFactor = D1 ('MetaData "SDL_BlendFactor" "SDL3.Sys.Bindgen.Blendmode" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_BlendFactor" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
type CEnumZ SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type FFIType SDL_BlendFactor Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

type CFieldType SDL_BlendFactor "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Blendmode

pattern SDL_BLENDFACTOR_ZERO :: SDL_BlendFactor Source #

0, 0, 0, 0

C declaration
SDL_BLENDFACTOR_ZERO, defined at SDL3/SDL_blendmode.h 90:5

pattern SDL_BLENDFACTOR_ONE :: SDL_BlendFactor Source #

1, 1, 1, 1

C declaration
SDL_BLENDFACTOR_ONE, defined at SDL3/SDL_blendmode.h 91:5

pattern SDL_BLENDFACTOR_SRC_COLOR :: SDL_BlendFactor Source #

srcR, srcG, srcB, srcA

C declaration
SDL_BLENDFACTOR_SRC_COLOR, defined at SDL3/SDL_blendmode.h 92:5

pattern SDL_BLENDFACTOR_ONE_MINUS_SRC_COLOR :: SDL_BlendFactor Source #

1-srcR, 1-srcG, 1-srcB, 1-srcA

C declaration
SDL_BLENDFACTOR_ONE_MINUS_SRC_COLOR, defined at SDL3/SDL_blendmode.h 93:5

pattern SDL_BLENDFACTOR_SRC_ALPHA :: SDL_BlendFactor Source #

srcA, srcA, srcA, srcA

C declaration
SDL_BLENDFACTOR_SRC_ALPHA, defined at SDL3/SDL_blendmode.h 94:5

pattern SDL_BLENDFACTOR_ONE_MINUS_SRC_ALPHA :: SDL_BlendFactor Source #

1-srcA, 1-srcA, 1-srcA, 1-srcA

C declaration
SDL_BLENDFACTOR_ONE_MINUS_SRC_ALPHA, defined at SDL3/SDL_blendmode.h 95:5

pattern SDL_BLENDFACTOR_DST_COLOR :: SDL_BlendFactor Source #

dstR, dstG, dstB, dstA

C declaration
SDL_BLENDFACTOR_DST_COLOR, defined at SDL3/SDL_blendmode.h 96:5

pattern SDL_BLENDFACTOR_ONE_MINUS_DST_COLOR :: SDL_BlendFactor Source #

1-dstR, 1-dstG, 1-dstB, 1-dstA

C declaration
SDL_BLENDFACTOR_ONE_MINUS_DST_COLOR, defined at SDL3/SDL_blendmode.h 97:5

pattern SDL_BLENDFACTOR_DST_ALPHA :: SDL_BlendFactor Source #

dstA, dstA, dstA, dstA

C declaration
SDL_BLENDFACTOR_DST_ALPHA, defined at SDL3/SDL_blendmode.h 98:5

pattern SDL_BLENDFACTOR_ONE_MINUS_DST_ALPHA :: SDL_BlendFactor Source #

1-dstA, 1-dstA, 1-dstA, 1-dstA

C declaration
SDL_BLENDFACTOR_ONE_MINUS_DST_ALPHA, defined at SDL3/SDL_blendmode.h 99:5