Differential D15953 Diff 56012 intern/ghost/intern/GHOST_ContextCGL.h

Changeset View

Standalone View

intern/ghost/intern/GHOST_ContextCGL.h

/* SPDX-License-Identifier: GPL-2.0-or-later		/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2014 Blender Foundation. All rights reserved. */		* Copyright 2014 Blender Foundation. All rights reserved. */

/** \file		/** \file
* \ingroup GHOST		* \ingroup GHOST
*/		*/

#pragma once		#pragma once

#include "GHOST_Context.h"		#include "GHOST_Context.h"

		#include <Cocoa/Cocoa.h>
		#include <Metal/Metal.h>
		#include <QuartzCore/QuartzCore.h>

@class CAMetalLayer;		@class CAMetalLayer;
@class MTLCommandQueue;		@class MTLCommandQueue;
		@class MTLDevice;
@class MTLRenderPipelineState;		@class MTLRenderPipelineState;
@class MTLTexture;		@class MTLTexture;
@class NSOpenGLContext;		@class NSOpenGLContext;
@class NSOpenGLView;		@class NSOpenGLView;
@class NSView;		@class NSView;

class GHOST_ContextCGL : public GHOST_Context {		class GHOST_ContextCGL : public GHOST_Context {
public:		public:
Show All 9 Lines	public:
* Destructor.		* Destructor.
*/		*/
~GHOST_ContextCGL();		~GHOST_ContextCGL();

/**		/**
* Swaps front and back buffers of a window.		* Swaps front and back buffers of a window.
* \return A boolean success indicator.		* \return A boolean success indicator.
*/		*/
GHOST_TSuccess swapBuffers();		GHOST_TSuccess swapBuffers() override;

/**		/**
* Activates the drawing context of this window.		* Activates the drawing context of this window.
* \return A boolean success indicator.		* \return A boolean success indicator.
*/		*/
GHOST_TSuccess activateDrawingContext();		GHOST_TSuccess activateDrawingContext() override;

/**		/**
* Release the drawing context of the calling thread.		* Release the drawing context of the calling thread.
* \return A boolean success indicator.		* \return A boolean success indicator.
*/		*/
GHOST_TSuccess releaseDrawingContext();		GHOST_TSuccess releaseDrawingContext() override;

unsigned int getDefaultFramebuffer();		unsigned int getDefaultFramebuffer() override;

/**		/**
* Call immediately after new to initialize. If this fails then immediately delete the object.		* Call immediately after new to initialize. If this fails then immediately delete the object.
* \return Indication as to whether initialization has succeeded.		* \return Indication as to whether initialization has succeeded.
*/		*/
GHOST_TSuccess initializeDrawingContext();		GHOST_TSuccess initializeDrawingContext() override;

/**		/**
* Removes references to native handles from this context and then returns		* Removes references to native handles from this context and then returns
* \return GHOST_kSuccess if it is OK for the parent to release the handles and		* \return GHOST_kSuccess if it is OK for the parent to release the handles and
* GHOST_kFailure if releasing the handles will interfere with sharing		* GHOST_kFailure if releasing the handles will interfere with sharing
*/		*/
GHOST_TSuccess releaseNativeHandles();		GHOST_TSuccess releaseNativeHandles() override;

/**		/**
* Sets the swap interval for #swapBuffers.		* Sets the swap interval for #swapBuffers.
* \param interval: The swap interval to use.		* \param interval: The swap interval to use.
* \return A boolean success indicator.		* \return A boolean success indicator.
*/		*/
GHOST_TSuccess setSwapInterval(int interval);		GHOST_TSuccess setSwapInterval(int interval) override;

/**		/**
* Gets the current swap interval for #swapBuffers.		* Gets the current swap interval for #swapBuffers.
* \param intervalOut: Variable to store the swap interval if it can be read.		* \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.		* \return Whether the swap interval can be read.
*/		*/
GHOST_TSuccess getSwapInterval(int &);		GHOST_TSuccess getSwapInterval(int &) override;

/**		/**
* Updates the drawing context of this window.		* Updates the drawing context of this window.
* Needed whenever the window is changed.		* Needed whenever the window is changed.
* \return Indication of success.		* \return Indication of success.
*/		*/
GHOST_TSuccess updateDrawingContext();		GHOST_TSuccess updateDrawingContext() override;

		/**
		* Returns a texture that Metal code can use as a render target. The current
		* contents of this texture will be composited on top of the framebuffer
		* each time `swapBuffers` is called.
		*/
		id<MTLTexture> metalOverlayTexture();

		/**
		* Return a pointer to the Metal command queue used by this context.
		*/
		MTLCommandQueue *metalCommandQueue();

		/**
		* Return a pointer to the Metal device associated with this context.
		*/
		MTLDevice *metalDevice();

		/**
		* Register present callback
		*/
		void metalRegisterPresentCallback(void (*callback)(
		MTLRenderPassDescriptor *, id<MTLRenderPipelineState>, id<MTLTexture>, id<CAMetalDrawable>));

private:		private:
/** Metal state */		/** Metal state */
		/* Set this flag to `true` when rendering with Metal API for Viewport.
		* TODO(Metal): This should be assigned to externally. */
		bool m_useMetalForRendering = false;
NSView *m_metalView;		NSView *m_metalView;
CAMetalLayer *m_metalLayer;		CAMetalLayer *m_metalLayer;
MTLCommandQueue *m_metalCmdQueue;		MTLCommandQueue *m_metalCmdQueue;
MTLRenderPipelineState *m_metalRenderPipeline;		MTLRenderPipelineState *m_metalRenderPipeline;
		bool m_ownsMetalDevice;

/** OpenGL state, for GPUs that don't support Metal */		/** OpenGL state, for GPUs that don't support Metal */
NSOpenGLView *m_openGLView;		NSOpenGLView *m_openGLView;

/** The OpenGL drawing context */		/** The OpenGL drawing context */
NSOpenGLContext *m_openGLContext;		NSOpenGLContext *m_openGLContext;

/** The virtualized default frame-buffer. */		/** The virtualized default frame-buffer. */
unsigned int m_defaultFramebuffer;		unsigned int m_defaultFramebuffer;

/** The virtualized default frame-buffer's texture. */		/** The virtualized default framebuffer's texture */
MTLTexture *m_defaultFramebufferMetalTexture;		/**
		* Texture that you can render into with Metal. The texture will be
		* composited on top of `m_defaultFramebufferMetalTexture` whenever
		* `swapBuffers` is called.
		*/
		static const int METAL_SWAPCHAIN_SIZE = 3;
		struct MTLSwapchainTexture {
		id<MTLTexture> texture;
		unsigned int index;
		};
		MTLSwapchainTexture m_defaultFramebufferMetalTexture[METAL_SWAPCHAIN_SIZE];
		unsigned int current_swapchain_index = 0;

		/* Present callback.
		* We use this such that presentation can be controlled from within the Metal
		* Context. This is required for optimal performance and clean control flow.
		* Also helps ensure flickering does not occur by present being dependent
		* on existing submissions. */
		void (contextPresentCallback)(MTLRenderPassDescriptor ,
		id<MTLRenderPipelineState>,
		id<MTLTexture>,
		id<CAMetalDrawable>);

		int mtl_SwapInterval;
const bool m_debug;		const bool m_debug;

/** The first created OpenGL context (for sharing display lists) */		/** The first created OpenGL context (for sharing display lists) */
static NSOpenGLContext *s_sharedOpenGLContext;		static NSOpenGLContext *s_sharedOpenGLContext;
static int s_sharedCount;		static int s_sharedCount;

/* Metal functions */		/* Metal functions */
void metalInit();		void metalInit();
void metalFree();		void metalFree();
void metalInitFramebuffer();		void metalInitFramebuffer();
void metalUpdateFramebuffer();		void metalUpdateFramebuffer();
void metalSwapBuffers();		void metalSwapBuffers();
		void initClear();
};		};