vulkandraw

README

VulkanDraw

Supported platforms

• Windows (GLFW)
• Android (Native)
• Linux graphics (GLFW)
• OS X / macOS (GLFW + MoltenVK)
• iOS (Metal + MoltenVK)

License

WTFPL

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func DestroyInOrder(v *VulkanDeviceInfo, s *VulkanSwapchainInfo, r *VulkanRenderInfo, ...)
• func LoadShader(device vk.Device, name string) (vk.ShaderModule, error)
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func VulkanDrawFrame(v VulkanDeviceInfo, s VulkanSwapchainInfo, r VulkanRenderInfo) bool
• func VulkanInit(v *VulkanDeviceInfo, s *VulkanSwapchainInfo, r *VulkanRenderInfo, ...)
• type VulkanBufferInfo
  • func (v *VulkanBufferInfo) DefaultVertexBuffer() vk.Buffer
  • func (buf *VulkanBufferInfo) Destroy()
• type VulkanDeviceInfo
  • func NewVulkanDevice(appInfo *vk.ApplicationInfo, window uintptr, instanceExtensions []string, ...) (VulkanDeviceInfo, error)
  • func (v VulkanDeviceInfo) CreateBuffers() (VulkanBufferInfo, error)
  • func (v *VulkanDeviceInfo) CreateSwapchain() (VulkanSwapchainInfo, error)
• type VulkanGfxPipelineInfo
  • func CreateGraphicsPipeline(device vk.Device, displaySize vk.Extent2D, renderPass vk.RenderPass) (VulkanGfxPipelineInfo, error)
  • func (gfx *VulkanGfxPipelineInfo) Destroy()
• type VulkanRenderInfo
  • func CreateRenderer(device vk.Device, displayFormat vk.Format) (VulkanRenderInfo, error)
  • func (r *VulkanRenderInfo) CreateCommandBuffers(n uint32) error
  • func (v *VulkanRenderInfo) DefaultFence() vk.Fence
  • func (v *VulkanRenderInfo) DefaultSemaphore() vk.Semaphore
• type VulkanSwapchainInfo
  • func (s *VulkanSwapchainInfo) CreateFramebuffers(renderPass vk.RenderPass, depthView vk.ImageView) error
  • func (v *VulkanSwapchainInfo) DefaultSwapchain() vk.Swapchain
  • func (v *VulkanSwapchainInfo) DefaultSwapchainLen() uint32
  • func (s *VulkanSwapchainInfo) Destroy()

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func DestroyInOrder

func DestroyInOrder(v *VulkanDeviceInfo, s *VulkanSwapchainInfo,
	r *VulkanRenderInfo, b *VulkanBufferInfo, gfx *VulkanGfxPipelineInfo)

func LoadShader

func LoadShader(device vk.Device, name string) (vk.ShaderModule, error)

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func VulkanDrawFrame

func VulkanDrawFrame(v VulkanDeviceInfo,
	s VulkanSwapchainInfo, r VulkanRenderInfo) bool

func VulkanInit

func VulkanInit(v *VulkanDeviceInfo, s *VulkanSwapchainInfo,
	r *VulkanRenderInfo, b *VulkanBufferInfo, gfx *VulkanGfxPipelineInfo)

Types

type VulkanBufferInfo

type VulkanBufferInfo struct {
	// contains filtered or unexported fields
}

func (*VulkanBufferInfo) DefaultVertexBuffer

func (v *VulkanBufferInfo) DefaultVertexBuffer() vk.Buffer

func (*VulkanBufferInfo) Destroy

func (buf *VulkanBufferInfo) Destroy()

type VulkanDeviceInfo

type VulkanDeviceInfo struct {
	Instance vk.Instance
	Surface  vk.Surface
	Queue    vk.Queue
	Device   vk.Device
	// contains filtered or unexported fields
}

func NewVulkanDevice

func NewVulkanDevice(appInfo *vk.ApplicationInfo, window uintptr, instanceExtensions []string, createSurfaceFunc func(interface{}) uintptr) (VulkanDeviceInfo, error)

func (VulkanDeviceInfo) CreateBuffers

func (v VulkanDeviceInfo) CreateBuffers() (VulkanBufferInfo, error)

func (*VulkanDeviceInfo) CreateSwapchain

func (v *VulkanDeviceInfo) CreateSwapchain() (VulkanSwapchainInfo, error)

type VulkanGfxPipelineInfo

type VulkanGfxPipelineInfo struct {
	// contains filtered or unexported fields
}

func CreateGraphicsPipeline

func CreateGraphicsPipeline(device vk.Device,
	displaySize vk.Extent2D, renderPass vk.RenderPass) (VulkanGfxPipelineInfo, error)

func (*VulkanGfxPipelineInfo) Destroy

func (gfx *VulkanGfxPipelineInfo) Destroy()

type VulkanRenderInfo

type VulkanRenderInfo struct {
	RenderPass vk.RenderPass
	// contains filtered or unexported fields
}

func CreateRenderer

func CreateRenderer(device vk.Device, displayFormat vk.Format) (VulkanRenderInfo, error)

func (*VulkanRenderInfo) CreateCommandBuffers

func (r *VulkanRenderInfo) CreateCommandBuffers(n uint32) error

func (*VulkanRenderInfo) DefaultFence

func (v *VulkanRenderInfo) DefaultFence() vk.Fence

func (*VulkanRenderInfo) DefaultSemaphore

func (v *VulkanRenderInfo) DefaultSemaphore() vk.Semaphore

type VulkanSwapchainInfo

type VulkanSwapchainInfo struct {
	Device vk.Device

	Swapchains   []vk.Swapchain
	SwapchainLen []uint32

	DisplaySize   vk.Extent2D
	DisplayFormat vk.Format

	Framebuffers []vk.Framebuffer
	DisplayViews []vk.ImageView
}

func (*VulkanSwapchainInfo) CreateFramebuffers

func (s *VulkanSwapchainInfo) CreateFramebuffers(renderPass vk.RenderPass, depthView vk.ImageView) error

func (*VulkanSwapchainInfo) DefaultSwapchain

func (v *VulkanSwapchainInfo) DefaultSwapchain() vk.Swapchain

func (*VulkanSwapchainInfo) DefaultSwapchainLen

func (v *VulkanSwapchainInfo) DefaultSwapchainLen() uint32

func (*VulkanSwapchainInfo) Destroy

func (s *VulkanSwapchainInfo) Destroy()