BansheeEngine/Source/BansheeCore/Include/BsPixelBuffer.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsCorePrerequisites.h"
#include "BsHardwareBuffer.h"
#include "BsPixelUtil.h"

namespace BansheeEngine 
{
	/** @addtogroup RenderAPI-Internal
	 *  @{
	 */

	/**
	 * Represents a hardware buffer that stores a single pixel surface. This may be a 1D, 2D or 3D surface, but unlike a 
	 * texture it consists only of a single surface (no mip maps, cube map faces or similar).
	 *
	 * @note	Core thread only
	 */
    class BS_CORE_EXPORT PixelBuffer : public HardwareBuffer
    {
    public:
		/**
		 * Constructs a new pixel buffer with the provided settings.
		 *
		 * @param[in]	width			Width of the pixel buffer in pixels.
		 * @param[in]	height			Height of the pixel buffer in pixels.
		 * @param[in]	depth			Depth of the pixel buffer in pixels (number of 2D slices).
		 * @param[in]	format			Format of each pixel in the buffer.
		 * @param[in]	usage			Usage signaling the render system how we plan on using the buffer.
		 * @param[in]	useSystemMemory	True if buffer should be allocated in system memory.
		 */
        PixelBuffer(UINT32 width, UINT32 height, UINT32 depth, PixelFormat format, 
			GpuBufferUsage usage, bool useSystemMemory);
        ~PixelBuffer();

		// Make the other lock overloads visible.
        using HardwareBuffer::lock;	

		/**
		 * Locks a certain region of the pixel buffer for reading and returns a pointer to the locked region.
		 *
		 * @param[in]	lockBox		Region of the surface to lock.
		 * @param[in]	options		Lock options that hint the hardware on what you intend to do with the locked data.
		 *
		 * @note	Returned object is only valid while the lock is active.
		 */
		virtual const PixelData& lock(const PixelVolume& lockBox, GpuLockOptions options);
		
		/** @copydoc HardwareBuffer::lock */
        virtual void* lock(UINT32 offset, UINT32 length, GpuLockOptions options);
		
		/** @copydoc HardwareBuffer::readData */
		virtual void readData(UINT32 offset, UINT32 length, void* dest);

		/** @copydoc HardwareBuffer::writeData */
		virtual void writeData(UINT32 offset, UINT32 length, const void* source, 
			BufferWriteType writeFlags = BufferWriteType::Normal);

		/**	Returns width of the surface in pixels. */
        UINT32 getWidth() const { return mWidth; }

		/**	Returns height of the surface in pixels. */
        UINT32 getHeight() const { return mHeight; }

		/**	Returns depth of the surface in pixels. */
        UINT32 getDepth() const { return mDepth; }

		/**	Returns format of the pixels in the surface. */
        PixelFormat getFormat() const { return mFormat; }

	protected:
		friend class RenderTexture;

		/**	
		 * Internal implementation of the lock() method. 
		 *
		 * @copydoc	lock(const PixelVolume&, GpuLockOptions)
		 */
		virtual PixelData lockImpl(PixelVolume lockBox, GpuLockOptions options) = 0;

		/** @copydoc HardwareBuffer::lock(UINT32, UINT32, GpuLockOptions) */
		virtual void* lockImpl(UINT32 offset, UINT32 length, GpuLockOptions options);

	protected:
		UINT32 mWidth, mHeight, mDepth;
		UINT32 mRowPitch, mSlicePitch;
		PixelFormat mFormat;

		PixelData mCurrentLock;
		PixelVolume mLockedBox;
    };

	/** @} */
}