sdl3-bindgen-sys
Safe HaskellNone
LanguageGHC2021

SDL3.Sys.Bindgen.Surface

Description

SDL surfaces are buffers of pixels in system RAM. These are useful for passing around and manipulating images that are not stored in GPU memory.

SDL_Surface makes serious efforts to manage images in various formats, and provides a reasonable toolbox for transforming the data, including copying between surfaces, filling rectangles in the image data, etc.

There is also a simple .bmp loader, SDL_LoadBMP(), and a simple .png loader, SDL_LoadPNG(). SDL itself does not provide loaders for other file formats, but there are several excellent external libraries that do, including its own satellite library, SDL_image In general these functions are thread-safe in that they can be called on different threads with different surfaces. You should not try to modify any surface from two threads simultaneously. The flags on an SDL_Surface.

These are generally considered read-only.

Since: 3.2.0

Synopsis

Documentation

newtype SDL_SurfaceFlags Source #

C declaration
SDL_SurfaceFlags, defined at SDL3/SDL_surface.h 68:16

Constructors

SDL_SurfaceFlags 

Fields

Instances

Instances details
Bits SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

FiniteBits SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Bounded SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Enum SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Storable SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Generic SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type Rep SDL_SurfaceFlags 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

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

Defined in SDL3.Sys.Bindgen.Surface

Num SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Read SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Integral SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Real SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Show SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Eq SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Ord SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Prim SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

HasFFIType SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type FFIType SDL_SurfaceFlags 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

ReadRaw SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

StaticSize SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

WriteRaw SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Bitfield SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

HasCField SDL_SurfaceFlags "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_SurfaceFlags "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

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

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

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

Defined in SDL3.Sys.Bindgen.Surface

type Rep SDL_SurfaceFlags Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

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

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_SurfaceFlags "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

sDL_SURFACE_PREALLOCATED :: CUInt Source #

Surface uses preallocated pixel memory

C declaration
macro SDL_SURFACE_PREALLOCATED, defined at SDL3/SDL_surface.h 70:9

sDL_SURFACE_LOCK_NEEDED :: CUInt Source #

Surface needs to be locked to access pixels

C declaration
macro SDL_SURFACE_LOCK_NEEDED, defined at SDL3/SDL_surface.h 71:9

sDL_SURFACE_LOCKED :: CUInt Source #

Surface is currently locked

C declaration
macro SDL_SURFACE_LOCKED, defined at SDL3/SDL_surface.h 72:9

sDL_SURFACE_SIMD_ALIGNED :: CUInt Source #

Surface uses pixel memory allocated with SDL_aligned_alloc()

C declaration
macro SDL_SURFACE_SIMD_ALIGNED, defined at SDL3/SDL_surface.h 73:9

newtype SDL_ScaleMode Source #

The scaling mode.

C declaration
enum SDL_ScaleMode, defined at SDL3/SDL_surface.h 87:14

Since: 3.2.0

Constructors

SDL_ScaleMode 

Fields

Instances

Instances details
Storable SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Generic SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type Rep SDL_ScaleMode 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

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

Defined in SDL3.Sys.Bindgen.Surface

Show SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Eq SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Ord SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Prim SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

CEnum SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CEnumZ SDL_ScaleMode 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

SequentialCEnum SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

HasFFIType SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type FFIType SDL_ScaleMode 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

ReadRaw SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

StaticSize SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

WriteRaw SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

HasCField SDL_ScaleMode "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_ScaleMode "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_ScaleMode "unwrap" = CInt

Methods

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

ty ~ CInt => HasField "unwrap" SDL_ScaleMode ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

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

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_ScaleMode -> Ptr ty #

type Rep SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

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

Defined in SDL3.Sys.Bindgen.Surface

type FFIType SDL_ScaleMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_ScaleMode "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_ScaleMode "unwrap" = CInt

pattern SDL_SCALEMODE_INVALID :: SDL_ScaleMode Source #

C declaration
SDL_SCALEMODE_INVALID, defined at SDL3/SDL_surface.h 89:5

pattern SDL_SCALEMODE_NEAREST :: SDL_ScaleMode Source #

nearest pixel sampling

C declaration
SDL_SCALEMODE_NEAREST, defined at SDL3/SDL_surface.h 90:5

pattern SDL_SCALEMODE_LINEAR :: SDL_ScaleMode Source #

linear filtering

C declaration
SDL_SCALEMODE_LINEAR, defined at SDL3/SDL_surface.h 91:5

pattern SDL_SCALEMODE_PIXELART :: SDL_ScaleMode Source #

nearest pixel sampling with improved scaling for pixel art, available since SDL 3.4.0

C declaration
SDL_SCALEMODE_PIXELART, defined at SDL3/SDL_surface.h 92:5

newtype SDL_FlipMode Source #

The flip mode.

C declaration
enum SDL_FlipMode, defined at SDL3/SDL_surface.h 100:14

Since: 3.2.0

Constructors

SDL_FlipMode 

Fields

Instances

Instances details
Storable SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Generic SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type Rep SDL_FlipMode 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

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

Defined in SDL3.Sys.Bindgen.Surface

Show SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Eq SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Ord SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Prim SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

CEnum SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CEnumZ SDL_FlipMode 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

SequentialCEnum SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

HasFFIType SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type FFIType SDL_FlipMode 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

ReadRaw SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

StaticSize SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

WriteRaw SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

HasCField SDL_FlipMode "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_FlipMode "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_FlipMode "unwrap" = CUInt

Methods

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

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

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

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

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_FlipMode -> Ptr ty #

type Rep SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

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

Defined in SDL3.Sys.Bindgen.Surface

type FFIType SDL_FlipMode Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_FlipMode "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_FlipMode "unwrap" = CUInt

pattern SDL_FLIP_NONE :: SDL_FlipMode Source #

Do not flip

C declaration
SDL_FLIP_NONE, defined at SDL3/SDL_surface.h 102:5

pattern SDL_FLIP_HORIZONTAL :: SDL_FlipMode Source #

flip horizontally

C declaration
SDL_FLIP_HORIZONTAL, defined at SDL3/SDL_surface.h 103:5

pattern SDL_FLIP_VERTICAL :: SDL_FlipMode Source #

flip vertically

C declaration
SDL_FLIP_VERTICAL, defined at SDL3/SDL_surface.h 104:5

pattern SDL_FLIP_HORIZONTAL_AND_VERTICAL :: SDL_FlipMode Source #

flip horizontally and vertically (not a diagonal flip)

C declaration
SDL_FLIP_HORIZONTAL_AND_VERTICAL, defined at SDL3/SDL_surface.h 105:5

data SDL_Surface Source #

A collection of pixels used in software blitting.

Pixels are arranged in memory in rows, with the top row first. Each row occupies an amount of memory given by the pitch (sometimes known as the row stride in non-SDL APIs).

Within each row, pixels are arranged from left to right until the width is reached. Each pixel occupies a number of bits appropriate for its format, with most formats representing each pixel as one or more whole bytes (in some indexed formats, instead multiple pixels are packed into each byte), and a byte order given by the format. After encoding all pixels, any remaining bytes to reach the pitch are used as padding to reach a desired alignment, and have undefined contents.

When a surface holds YUV format data, the planes are assumed to be contiguous without padding between them, e.g. a 32x32 surface in NV12 format with a pitch of 32 would consist of 32x32 bytes of Y plane followed by 32x16 bytes of UV plane.

When a surface holds MJPG format data, pixels points at the compressed JPEG image and pitch is the length of that data.

See also
sDL_CreateSurface, sDL_DestroySurface
C declaration
struct SDL_Surface, defined at SDL3/SDL_surface.h 138:8

Since: 3.2.0

Constructors

SDL_Surface 

Fields

  • flags :: SDL_SurfaceFlags

    The flags of the surface, read-only

    C declaration
    flags, defined at SDL3/SDL_surface.h 140:22
  • format :: SDL_PixelFormat

    The format of the surface, read-only

    C declaration
    format, defined at SDL3/SDL_surface.h 141:21
  • w :: CInt

    The width of the surface, read-only.

    C declaration
    w, defined at SDL3/SDL_surface.h 142:9
  • h :: CInt

    The height of the surface, read-only.

    C declaration
    h, defined at SDL3/SDL_surface.h 143:9
  • pitch :: CInt

    The distance in bytes between rows of pixels, read-only

    C declaration
    pitch, defined at SDL3/SDL_surface.h 144:9
  • pixels :: Ptr Void

    A pointer to the pixels of the surface, the pixels are writeable if non-NULL

    C declaration
    pixels, defined at SDL3/SDL_surface.h 145:11
  • refcount :: CInt

    Application reference count, used when freeing surface

    C declaration
    refcount, defined at SDL3/SDL_surface.h 147:9
  • reserved :: Ptr Void

    Reserved for internal use

    C declaration
    reserved, defined at SDL3/SDL_surface.h 149:11

Instances

Instances details
Storable SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Generic SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Show SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Eq SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

ReadRaw SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

StaticSize SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

WriteRaw SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

writeRaw :: Ptr SDL_Surface -> SDL_Surface -> IO () #

IsStruct SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

zero :: SDL_Surface #

HasCField SDL_Surface "flags" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "flags" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "flags" -> Int #

HasCField SDL_Surface "format" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "format" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "format" -> Int #

HasCField SDL_Surface "h" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "h" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "h" -> Int #

HasCField SDL_Surface "pitch" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "pitch" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "pitch" = CInt

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "pitch" -> Int #

HasCField SDL_Surface "pixels" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "pixels" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "pixels" = Ptr Void

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "pixels" -> Int #

HasCField SDL_Surface "refcount" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "refcount" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "refcount" = CInt

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "refcount" -> Int #

HasCField SDL_Surface "reserved" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "reserved" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "reserved" = Ptr Void

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "reserved" -> Int #

HasCField SDL_Surface "w" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Associated Types

type CFieldType SDL_Surface "w" 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

offset# :: Proxy# SDL_Surface -> Proxy# "w" -> Int #

ty ~ SDL_SurfaceFlags => HasField "flags" SDL_Surface ty Source #

The flags of the surface, read-only

C declaration
flags, defined at SDL3/SDL_surface.h 140:22
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ SDL_PixelFormat => HasField "format" SDL_Surface ty Source #

The format of the surface, read-only

C declaration
format, defined at SDL3/SDL_surface.h 141:21
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ CInt => HasField "h" SDL_Surface ty Source #

The height of the surface, read-only.

C declaration
h, defined at SDL3/SDL_surface.h 143:9
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ CInt => HasField "pitch" SDL_Surface ty Source #

The distance in bytes between rows of pixels, read-only

C declaration
pitch, defined at SDL3/SDL_surface.h 144:9
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ Ptr Void => HasField "pixels" SDL_Surface ty Source #

A pointer to the pixels of the surface, the pixels are writeable if non-NULL

C declaration
pixels, defined at SDL3/SDL_surface.h 145:11
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ CInt => HasField "refcount" SDL_Surface ty Source #

Application reference count, used when freeing surface

C declaration
refcount, defined at SDL3/SDL_surface.h 147:9
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ Ptr Void => HasField "reserved" SDL_Surface ty Source #

Reserved for internal use

C declaration
reserved, defined at SDL3/SDL_surface.h 149:11
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ CInt => HasField "w" SDL_Surface ty Source #

The width of the surface, read-only.

C declaration
w, defined at SDL3/SDL_surface.h 142:9
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

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

ty ~ SDL_SurfaceFlags => HasField "flags" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ SDL_PixelFormat => HasField "format" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ CInt => HasField "h" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ CInt => HasField "pitch" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ Ptr Void => HasField "pixels" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ CInt => HasField "refcount" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ Ptr Void => HasField "reserved" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

ty ~ CInt => HasField "w" (Ptr SDL_Surface) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

Methods

getField :: Ptr SDL_Surface -> Ptr ty #

type Rep SDL_Surface Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "flags" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "format" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "h" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "pitch" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "pitch" = CInt
type CFieldType SDL_Surface "pixels" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "pixels" = Ptr Void
type CFieldType SDL_Surface "refcount" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "refcount" = CInt
type CFieldType SDL_Surface "reserved" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

type CFieldType SDL_Surface "reserved" = Ptr Void
type CFieldType SDL_Surface "w" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Surface

sDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT :: ByteString Source #

C declaration
macro SDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT, literal "SDL.surface.SDR_white_point", defined at SDL3/SDL_surface.h 261:9

sDL_PROP_SURFACE_HDR_HEADROOM_FLOAT :: ByteString Source #

C declaration
macro SDL_PROP_SURFACE_HDR_HEADROOM_FLOAT, literal "SDL.surface.HDR_headroom", defined at SDL3/SDL_surface.h 262:9

sDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING :: ByteString Source #

C declaration
macro SDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING, literal "SDL.surface.tonemap", defined at SDL3/SDL_surface.h 263:9

sDL_PROP_SURFACE_HOTSPOT_X_NUMBER :: ByteString Source #

C declaration
macro SDL_PROP_SURFACE_HOTSPOT_X_NUMBER, literal "SDL.surface.hotspot.x", defined at SDL3/SDL_surface.h 264:9

sDL_PROP_SURFACE_HOTSPOT_Y_NUMBER :: ByteString Source #

C declaration
macro SDL_PROP_SURFACE_HOTSPOT_Y_NUMBER, literal "SDL.surface.hotspot.y", defined at SDL3/SDL_surface.h 265:9

sDL_PROP_SURFACE_ROTATION_FLOAT :: ByteString Source #

C declaration
macro SDL_PROP_SURFACE_ROTATION_FLOAT, literal "SDL.surface.rotation", defined at SDL3/SDL_surface.h 266:9