MoltenVK/MoltenVK/Commands/MVKCmdDraw.h

/*
 * MVKCmdDraw.h
 *
 * Copyright (c) 2014-2018 The Brenwill Workshop Ltd. (http://www.brenwill.com)
 *
 * 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.
 */

#pragma once

#include "MVKCommand.h"
#include "MVKMTLResourceBindings.h"
#include <vector>

#import <Metal/Metal.h>

class MVKDevice;


#pragma mark -
#pragma mark MVKCmdBindVertexBuffers

/** Vulkan command to bind buffers containing vertex content. */
class MVKCmdBindVertexBuffers : public MVKCommand {

public:
	void setContent(uint32_t startBinding,
					uint32_t bindingCount,
					const VkBuffer* pBuffers,
					const VkDeviceSize* pOffsets);

    void encode(MVKCommandEncoder* cmdEncoder) override;

    MVKCmdBindVertexBuffers(MVKCommandTypePool<MVKCmdBindVertexBuffers>* pool);

protected:
    std::vector<MVKMTLBufferBinding> _bindings;
};


#pragma mark -
#pragma mark MVKCmdBindIndexBuffer

/** Vulkan command to bind a vertex index buffer. */
class MVKCmdBindIndexBuffer : public MVKCommand {

public:
	void setContent(VkBuffer buffer, VkDeviceSize offset, VkIndexType indexType);

	void encode(MVKCommandEncoder* cmdEncoder) override;

	MVKCmdBindIndexBuffer(MVKCommandTypePool<MVKCmdBindIndexBuffer>* pool);

protected:
    MVKIndexMTLBufferBinding _binding;
};


#pragma mark -
#pragma mark MVKCmdDraw

/** Vulkan command to draw vertices. */
class MVKCmdDraw : public MVKCommand {

public:
	void setContent(uint32_t vertexCount,
					uint32_t instanceCount,
					uint32_t firstVertex,
					uint32_t firstInstance);

    void encode(MVKCommandEncoder* cmdEncoder) override;

    MVKCmdDraw(MVKCommandTypePool<MVKCmdDraw>* pool);

protected:
	uint32_t _firstVertex;
	uint32_t _vertexCount;
	uint32_t _firstInstance;
	uint32_t _instanceCount;
};


#pragma mark -
#pragma mark MVKCmdDrawIndexed

/** Vulkan command to draw indexed vertices. */
class MVKCmdDrawIndexed : public MVKCommand {

public:
	void setContent(uint32_t indexCount,
					uint32_t instanceCount,
					uint32_t firstIndex,
					int32_t vertexOffset,
					uint32_t firstInstance);

	void encode(MVKCommandEncoder* cmdEncoder) override;

	MVKCmdDrawIndexed(MVKCommandTypePool<MVKCmdDrawIndexed>* pool);

protected:
	uint32_t _firstIndex;
	uint32_t _indexCount;
	int32_t	_vertexOffset;
	uint32_t _firstInstance;
	uint32_t _instanceCount;
};


#pragma mark -
#pragma mark MVKCmdDrawIndirect

/** Vulkan command to draw vertices indirectly. */
class MVKCmdDrawIndirect : public MVKCommand {

public:
	void setContent(VkBuffer buffer,
					VkDeviceSize offset,
					uint32_t count,
					uint32_t stride);

	void encode(MVKCommandEncoder* cmdEncoder) override;

	MVKCmdDrawIndirect(MVKCommandTypePool<MVKCmdDrawIndirect>* pool);

protected:
	id<MTLBuffer> _mtlIndirectBuffer;
	NSUInteger _mtlIndirectBufferOffset;
	uint32_t _mtlIndirectBufferStride;
	uint32_t _drawCount;
};


#pragma mark -
#pragma mark MVKCmdDrawIndexedIndirect

/** Vulkan command to draw indexed vertices indirectly. */
class MVKCmdDrawIndexedIndirect : public MVKCommand {

public:
	void setContent(VkBuffer buffer,
					VkDeviceSize offset,
					uint32_t count,
					uint32_t stride);

	void encode(MVKCommandEncoder* cmdEncoder) override;

	MVKCmdDrawIndexedIndirect(MVKCommandTypePool<MVKCmdDrawIndexedIndirect>* pool);

protected:
	id<MTLBuffer> _mtlIndirectBuffer;
	VkDeviceSize _mtlIndirectBufferOffset;
	uint32_t _mtlIndirectBufferStride;
	uint32_t _drawCount;
};


#pragma mark -
#pragma mark Command creation functions

/** Adds a vertex bind command to the specified command buffer. */
void mvkCmdBindVertexBuffers(MVKCommandBuffer* cmdBuff,
							 uint32_t startBinding,
							 uint32_t bindingCount,
							 const VkBuffer* pBuffers,
							 const VkDeviceSize* pOffsets);

/** Adds a bind index buffer command to the specified command buffer. */
void mvkCmdBindIndexBuffer(MVKCommandBuffer* cmdBuff,
						   VkBuffer buffer,
						   VkDeviceSize offset,
						   VkIndexType indexType);

/** Adds a vertex draw command to the specified command buffer. */
void mvkCmdDraw(MVKCommandBuffer* cmdBuff,
				uint32_t vertexCount,
				uint32_t instanceCount,
				uint32_t firstVertex,
				uint32_t firstInstance);

/** Adds an indexed draw command to the specified command buffer. */
void mvkCmdDrawIndexed(MVKCommandBuffer* cmdBuff,
					   uint32_t indexCount,
					   uint32_t instanceCount,
					   uint32_t firstIndex,
					   int32_t vertexOffset,
					   uint32_t firstInstance);

/** Adds an indirect draw command to the specified command buffer. */
void mvkCmdDrawIndirect(MVKCommandBuffer* cmdBuff,
						VkBuffer buffer,
						VkDeviceSize offset,
						uint32_t drawCount,
						uint32_t stride);

/** Adds an indirect indexed draw command to the specified command buffer. */
void mvkCmdDrawIndexedIndirect(MVKCommandBuffer* cmdBuff,
							   VkBuffer buffer,
							   VkDeviceSize offset,
							   uint32_t drawCount,
							   uint32_t stride);