cfg

Documentation

Index

• Constants
• type Attachment
• type AttachmentReference
• type ColorBlend
• type DepthStencil
• type DescriptorBinding
• type DescriptorSetLayout
• type InputAssembly
• type Options
• type Pipeline
• type PipelineLayout
• type PushConstantRange
• type Rasterization
• type RenderPass
• type Subpass
• type SubpassDependency
• type Suite
• type VertexAttribute
• type VertexBinding
• type VertexInputState
• type Viewport

Constants

const (
	FORMAT_CURRENT_SURFACE vk.Format = vk.FORMAT_END_RANGE + iota
	FORMAT_CURRENT_DEPTH
)

Types

type Attachment

type Attachment struct {
	Name           string
	Flags          vk.AttachmentDescriptionFlags
	Format         vk.Format
	Samples        vk.SampleCountFlags
	LoadOp         vk.AttachmentLoadOp
	StoreOp        vk.AttachmentStoreOp
	StencilLoadOp  vk.AttachmentLoadOp
	StencilStoreOp vk.AttachmentStoreOp
	InitialLayout  vk.ImageLayout
	FinalLayout    vk.ImageLayout
}

type AttachmentReference

type AttachmentReference = vk.AttachmentReference

AttachmentReference -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkAttachmentReference.html

type ColorBlend

type ColorBlend struct {
	Name                string
	BlendEnable         bool
	SrcColorBlendFactor vk.BlendFactor
	DstColorBlendFactor vk.BlendFactor
	ColorBlendOp        vk.BlendOp
	SrcAlphaBlendFactor vk.BlendFactor
	DstAlphaBlendFactor vk.BlendFactor
	AlphaBlendOp        vk.BlendOp
	ColorWriteMask      vk.ColorComponentFlags
}

ColorBlend -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkPipelineColorBlendAttachmentState.html

type DepthStencil

type DepthStencil struct {
	Name                  string
	Flags                 vk.PipelineDepthStencilStateCreateFlags
	DepthTestEnable       bool
	DepthWriteEnable      bool
	DepthCompareOp        vk.CompareOp
	DepthBoundsTestEnable bool
	StencilTestEnable     bool
	Front                 vk.StencilOpState
	Back                  vk.StencilOpState
	MinDepthBounds        float32
	MaxDepthBounds        float32
}

DepthStencil -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkPipelineDepthStencilStateCreateInfo.html

type DescriptorBinding

type DescriptorBinding = vk.DescriptorSetLayoutBinding

DescriptorBinding -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkDescriptorSetLayoutBinding.html

type DescriptorSetLayout

type DescriptorSetLayout struct {
	Name     string
	Flags    vk.DescriptorSetLayoutCreateFlags
	Bindings []DescriptorBinding
}

DescriptorSetLayout -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkDescriptorSetLayoutCreateInfo.html

type InputAssembly

type InputAssembly struct {
	Name     string
	Flags    vk.PipelineInputAssemblyStateCreateFlags // reserved
	Topology vk.PrimitiveTopology
	Restart  bool
}

InputAssembly -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkPipelineInputAssemblyStateCreateInfo.html

type Options

type Options struct {
	Vulkan struct {
		ApiVersion string
	}

	Debug struct {
		Report    int     // 0=OFF 1=ON 2=VERBOSE 3=FULL
		Wireframe float32 // verbose debug report
	}

	Application struct {
		Name    string `opt:"-"`
		Version string `opt:"-"`
	}
}

type Pipeline

type Pipeline struct {
	Shaders        []string
	VertexInput    string
	PipelineLayout string
	InputAssembly  string
	Viewports      []vk.Viewport
	Scissors       []vk.Rect2D
	DepthStencil   string
	Rasterization  string
	ColorBlends    []string
	RenderPass     vk.RenderPass
	Subpass        uint32
}

type PipelineLayout

type PipelineLayout struct {
	Name                 string
	DescriptorSetLayouts []string
	PushConstantRanges   []string
}

type PushConstantRange

type PushConstantRange struct {
	Name       string
	StageFlags vk.ShaderStageFlags
	Offset     uint32
	Size       uint32
}

PushConstantRange -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkPushConstantRange.html

type Rasterization

type Rasterization struct {
	Name                    string
	Flags                   vk.PipelineRasterizationStateCreateFlags // reserved
	DepthClampEnable        bool
	RasterizerDiscardEnable bool
	PolygonMode             vk.PolygonMode
	CullMode                vk.CullModeFlags
	FrontFace               vk.FrontFace
	DepthBiasEnable         bool
	DepthBiasConstantFactor float32
	DepthBiasClamp          float32
	DepthBiasSlopeFactor    float32
	LineWidth               float32
}

Rasterization -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkPipelineRasterizationStateCreateInfo.html

type RenderPass

type RenderPass struct {
	Name           string
	Flags          vk.RenderPassCreateFlags
	Attachments    []string
	Subpasses      []Subpass
	SubpassDepends []SubpassDependency
}

type Subpass

type Subpass struct {
	Flags                  vk.SubpassDescriptionFlags
	PipelineBindPoint      vk.PipelineBindPoint
	InputAttachments       []AttachmentReference
	ColorAttachments       []AttachmentReference
	ResolveAttachments     []AttachmentReference
	DepthStencilAttachment *AttachmentReference
	PreserveAttachments    []uint32
}

type SubpassDependency

type SubpassDependency = vk.SubpassDependency

SubpassDependency -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkSubpassDependency.html

type Suite

type Suite struct {
	InputAssemblies    []InputAssembly
	DepthStencils      []DepthStencil
	ColorBlends        []ColorBlend
	Rasterizations     []Rasterization
	VertexInputStates  []VertexInputState
	DescriptorLayouts  []DescriptorSetLayout
	PushConstantRanges []PushConstantRange
	PipelineLayouts    []PipelineLayout
	Attachments        []Attachment
	RenderPasses       []RenderPass

	EmbededFiles map[string][]byte
}

type VertexAttribute

type VertexAttribute = vk.VertexInputAttributeDescription

VertexAttribute -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkVertexInputAttributeDescription.html

type VertexBinding

type VertexBinding = vk.VertexInputBindingDescription

VertexBinding -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkVertexInputBindingDescription.html

type VertexInputState

type VertexInputState struct {
	Name       string
	Bindings   []VertexBinding
	Attributes []VertexAttribute
}

VertexInputState -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkPipelineVertexInputStateCreateInfo.html

type Viewport

type Viewport = vk.Viewport

Viewport -- https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkViewport.html