funes-0.1.0.0

Safe Haskell	None
Language	Haskell2010

Nes.Render.Frame

Contents

State
Frame
Buffer
Sprite Pixel
Pixel
Misc

Synopsis

data FrameState = MkFrameState {
- sdl2Frame :: !MemoryPointer
- pixelBuffer :: !(Buffer (Color, PixelType))
- spritePixels :: !SpritePixels
}
newFrameState :: IO FrameState
frameWidth :: Int
frameHeight :: Int
frameLength :: Int
frameSetPixel :: (Word8, Word8, Word8) -> (Int, Int) -> MemoryPointer -> IO ()
newtype Buffer a = MkBuffer {
- unBuffer :: IOVector a
}
bufferWidth :: Int
bufferHeight :: Int
bufferLength :: Int
bufferGet :: Coord -> Buffer a -> IO (Maybe a)
bufferSet :: a -> Coord -> Buffer a -> IO ()
bufferCoordToOffset :: Coord -> Int
bufferGetOffset :: Int -> Buffer a -> IO (Maybe a)
bufferSetOffset :: a -> Int -> Buffer a -> IO ()
type SpritePixel = (Color, SpritePriority)
type SpritePixels = Map Int SpritePixel
addSpritePixel :: Coord -> SpritePixel -> FrameState -> FrameState
foreachSpritePixel :: Monad m => (Int -> SpritePixel -> m ()) -> FrameState -> m ()
type Coord = (Int, Int)
type Color = (Word8, Word8, Word8)
data PixelType
- = TransparentBG
- | OpaqueBG
- | Sprite
data SpritePriority
- = Front
- | Back

State

data FrameState Source #

Constructors

MkFrameState
Fields sdl2Frame :: !MemoryPointer pixelBuffer :: !(Buffer (Color, PixelType)) spritePixels :: !SpritePixels

newFrameState :: IO FrameState Source #

Allocates the buffers and frame

Frame

frameWidth :: Int Source #

Width (in pixels of the frame)

frameHeight :: Int Source #

Height (in pixels of the frame)

frameLength :: Int Source #

Size, in bytes, of the frame

frameSetPixel :: (Word8, Word8, Word8) -> (Int, Int) -> MemoryPointer -> IO () Source #

Buffer

newtype Buffer a Source #

Constructors

MkBuffer
Fields unBuffer :: IOVector a

bufferWidth :: Int Source #

Width of the internal buffer

Equals frameWidth

bufferHeight :: Int Source #

Height of the internal buffer

_Warning_ is not equal to frameHeight

See https://www.nesdev.org/wiki/PPU_rendering#Vertical_blanking_lines_(241-260)

bufferLength :: Int Source #

Number of elements in a buffer

bufferGet :: Coord -> Buffer a -> IO (Maybe a) Source #

bufferSet :: a -> Coord -> Buffer a -> IO () Source #

bufferCoordToOffset :: Coord -> Int Source #

bufferGetOffset :: Int -> Buffer a -> IO (Maybe a) Source #

bufferSetOffset :: a -> Int -> Buffer a -> IO () Source #

Sprite Pixel

type SpritePixel = (Color, SpritePriority) Source #

type SpritePixels = Map Int SpritePixel Source #

addSpritePixel :: Coord -> SpritePixel -> FrameState -> FrameState Source #

foreachSpritePixel :: Monad m => (Int -> SpritePixel -> m ()) -> FrameState -> m () Source #

Pixel

type Coord = (Int, Int) Source #

type Color = (Word8, Word8, Word8) Source #

data PixelType Source #

Says _where_ the pixel comes from

Constructors

TransparentBG	An opaque background pixel (e.g. pipe in mario)
OpaqueBG	A transparent background pixel (e.g. sky in mario)
Sprite	Pixel from a sprite

Instances

Instances details

Show PixelType Source #
Instance details Defined in Nes.Render.Frame Methods showsPrec :: Int -> PixelType -> ShowS # show :: PixelType -> String # showList :: [PixelType] -> ShowS #
Eq PixelType Source #
Instance details Defined in Nes.Render.Frame Methods (==) :: PixelType -> PixelType -> Bool # (/=) :: PixelType -> PixelType -> Bool #

Misc

data SpritePriority Source #

Priority of the sprite (from bit 5 of attribute table)

https://www.nesdev.org/wiki/PPU_sprite_priority

Constructors

Front
Back

Instances

Instances details

Show SpritePriority Source #
Instance details Defined in Nes.Render.Frame Methods showsPrec :: Int -> SpritePriority -> ShowS # show :: SpritePriority -> String # showList :: [SpritePriority] -> ShowS #
Eq SpritePriority Source #
Instance details Defined in Nes.Render.Frame Methods (==) :: SpritePriority -> SpritePriority -> Bool # (/=) :: SpritePriority -> SpritePriority -> Bool #