-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Utils for the vulkan package
--   
--   Utils for the vulkan package
@package vulkan-utils
@version 0.1.3

module Vulkan.Utils.Debug

-- | A debug callback which prints the message prefixed with "Validation: "
--   to stderr.
debugCallbackPtr :: PFN_vkDebugUtilsMessengerCallbackEXT

-- | A debug callback the same as <a>debugCallbackPtr</a> except it will
--   call <tt>abort</tt> when
--   <tt>VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT</tt> is set.
debugCallbackFatalPtr :: PFN_vkDebugUtilsMessengerCallbackEXT

-- | Assign a name to a handle using <a>setDebugUtilsObjectNameEXT</a>,
--   note that the <tt>VK_EXT_debug_utils</tt> extension must be enabled.
nameObject :: (HasObjectType a, MonadIO m) => Device -> a -> ByteString -> m ()

module Vulkan.Utils.FromGL

-- | Convert an OpenGL format enum into a <a>Format</a>
--   
--   <pre>
--   &gt;&gt;&gt; internalFormat 0x8051
--   Just FORMAT_R8G8B8_UNORM
--   </pre>
internalFormat :: (Eq a, Num a) => a -> Maybe Format

module Vulkan.Utils.ShaderQQ.Interpolate

-- | <a>interpExp</a> performs very simple interpolation of Haskell values
--   into <a>String</a>s.
--   
--   <ul>
--   <li>Interpolated variables are prefixed with <tt>$</tt></li>
--   <li>They can optionally be surrounded with braces like
--   <tt>${foo}</tt></li>
--   <li>Interpolated variables are converted to strings with
--   <a>show</a></li>
--   <li>To escape a <tt>$</tt> use <tt>\$</tt></li>
--   </ul>
--   
--   <pre>
--   &gt;&gt;&gt; let foo = 123 in $(interpExp "hello, $foo")
--   "hello, 123"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; let foo = "world" in $(interpExp "hello, \\$foo")
--   "hello, $foo"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; let foo = "world" in $(interpExp "hello\r\n\rworld")
--   "hello\r\n\rworld"
--   </pre>
interpExp :: String -> Q Exp

module Vulkan.Utils.ShaderQQ

-- | <a>glsl</a> is a QuasiQuoter which produces GLSL source code with
--   <tt>#line</tt> directives inserted so that error locations point to
--   the correct location in the Haskell source file. It also permits basic
--   string interpolation.
--   
--   <ul>
--   <li>Interpolated variables are prefixed with <tt>$</tt></li>
--   <li>They can optionally be surrounded with braces like
--   <tt>${foo}</tt></li>
--   <li>Interpolated variables are converted to strings with
--   <a>show</a></li>
--   <li>To escape a <tt>$</tt> use <tt>\$</tt></li>
--   </ul>
--   
--   It is intended to be used in concert with <a>compileShaderQ</a> like
--   so
--   
--   <pre>
--   myConstant = 3.141 -- Note that this will have to be in a different module
--   myFragmentShader = $(compileShaderQ "frag" [glsl|
--     #version 450
--     const float myConstant = ${myConstant};
--     main (){
--     }
--   |])
--   </pre>
--   
--   An explicit example (<tt><a>interactive</a></tt> is from doctest):
--   
--   <pre>
--   &gt;&gt;&gt; let version = 450 :: Int in [glsl|#version $version|]
--   "#version 450\n#extension GL_GOOGLE_cpp_style_line_directive : enable\n#line 32 \"&lt;interactive&gt;\"\n"
--   </pre>
--   
--   Note that line number will be thrown off if any of the interpolated
--   variables contain newlines.
glsl :: QuasiQuoter

-- | QuasiQuoter for creating a compute shader.
--   
--   Equivalent to calling <tt>$(compileShaderQ "comp" [glsl|...|])</tt>
--   without interpolation support.
comp :: QuasiQuoter

-- | QuasiQuoter for creating a fragment shader.
--   
--   Equivalent to calling <tt>$(compileShaderQ "frag" [glsl|...|])</tt>
--   without interpolation support.
frag :: QuasiQuoter

-- | QuasiQuoter for creating a geometry shader.
--   
--   Equivalent to calling <tt>$(compileShaderQ "geom" [glsl|...|])</tt>
--   without interpolation support.
geom :: QuasiQuoter

-- | QuasiQuoter for creating a tessellation control shader.
--   
--   Equivalent to calling <tt>$(compileShaderQ "tesc" [glsl|...|])</tt>
--   without interpolation support.
tesc :: QuasiQuoter

-- | QuasiQuoter for creating a tessellation evaluation shader.
--   
--   Equivalent to calling <tt>$(compileShaderQ "tese" [glsl|...|])</tt>
--   without interpolation support.
tese :: QuasiQuoter

-- | QuasiQuoter for creating a vertex shader.
--   
--   Equivalent to calling <tt>$(compileShaderQ "vert" [glsl|...|])</tt>
--   without interpolation support.
vert :: QuasiQuoter
type GLSLError = String
type GLSLWarning = String

-- | Compile a glsl shader to spir-v using glslangValidator.
--   
--   Messages are converted to GHC warnings or errors depending on
--   compilation success.
compileShaderQ :: String -> String -> Q Exp

-- | Compile a glsl shader to spir-v using glslangValidator
compileShader :: MonadIO m => Maybe Loc -> String -> String -> m ([GLSLWarning], Either [GLSLError] ByteString)
processValidatorMessages :: ByteString -> ([GLSLWarning], [GLSLError])