AudioSource.hs

{-# LANGUAGE StandaloneDeriving, DeriveDataTypeable #-}

-- This source file is part of HGamer3D
-- (A project to enable 3D game development in Haskell)
-- For the latest info, see http://www.hgamer3d.org
--
-- (c) 2011-2014 Peter Althainz
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
--     http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.

-- HGamer3D/Audio/Schema/AudioSource.hs

-- | data types which describes an Audio Source
module HGamer3D.Audio.Schema.AudioSource

where

import qualified HGamer3D.Data as D
import Data.Typeable

-- | The Source itself
data AudioSource = MusicSource String AudioSourceParameter
                 | SoundSource String AudioSourceParameter
                   deriving (Eq, Show, Typeable)

-- | Audio Parameter
data AudioSourceParameter = Parameter {
  volume :: Float,        -- ^ Volume 0.0 - 100.0
  loopFlag :: Bool,       -- ^ is sound looping
  positionFlag :: Bool,   -- ^ is sound position dependent
  pitch :: Float,         -- ^ Frequency change, 1.0 no change
  attenuation :: Float,   -- ^ Damping factor by distance, default 1.0, 0.0 no damping
  minDistance :: Float    -- ^ at min distance, sound is played with volume 100.0
} deriving (Eq, Show, Typeable)

-- | Audio Slots
data AudioSlots = AudioSlots [(String, AudioSource)] deriving (Eq, Show, Typeable)