Context Class Reference

Context contains the render state used by various components. More...

#import <Context.h>

Inheritance diagram for Context:

Collaboration diagram for Context:

Instance Methods
(instancetype)	- initWithDevice:layer:library:
(Texture *)	- newTexture:filter:
(id< MTLTexture >)	- newTexture:mipmapped:
(void)	- convertFormat:from:to:
(id< MTLRenderPipelineState >)	- getStockShader:blend:
(void)	- resetRenderViewport
	resets the viewport for the main render encoder to the drawable size More...
(void)	- resetScissorRect
	resets the scissor rect for the main render encoder to the drawable size More...
(void)	- drawQuadX:y:w:h:r:g:b:a:
	draws a quad at the specified position (normalized coordinates) using the main render encoder More...
(bool)	- allocRange:length:
(void)	- begin
	begin marks the beginning of a frame More...
(void)	- end
	end commits the command buffer More...
(void)	- setRotation:
(bool)	- readBackBuffer:
(void)	- setViewport: [implementation]
(void)	- setDisplaySyncEnabled: [implementation]
(MTLVertexDescriptor *)	- _spriteVertexDescriptor [implementation]
(bool)	- _initClearState [implementation]
(bool)	- _initMenuStates [implementation]
(bool)	- _initConversionFilters [implementation]
(void)	- _nextChain [implementation]
(void)	- setCaptureEnabled: [implementation]

Properties
id< MTLDevice >	device
id< MTLLibrary >	library
MTLClearColor	clearColor
video_viewport_t *	viewport
Uniforms *	uniforms
bool	displaySyncEnabled
	Specifies whether rendering is synchronized with the display. More...
bool	captureEnabled
	captureEnabled allows previous frames to be read More...
id< MTLCommandBuffer >	blitCommandBuffer
	Returns the command buffer used for pre-render work, such as mip maps and shader effects. More...
id< MTLCommandBuffer >	commandBuffer
	Returns the command buffer for the current frame. More...
id< CAMetalDrawable >	nextDrawable
id< MTLRenderCommandEncoder >	rce
	Main render encoder to back buffer. More...

Detailed Description

Context contains the render state used by various components.

Method Documentation

_initClearState()

- (bool) _initClearState

implementation

Here is the call graph for this function:

Here is the caller graph for this function:

_initConversionFilters()

- (bool) _initConversionFilters

implementation

Here is the call graph for this function:

Here is the caller graph for this function:

_initMenuStates()

- (bool) _initMenuStates

implementation

Here is the call graph for this function:

Here is the caller graph for this function:

_nextChain()

- (void) _nextChain

implementation

Here is the caller graph for this function:

_spriteVertexDescriptor()

- (MTLVertexDescriptor *) _spriteVertexDescriptor

implementation

Here is the caller graph for this function:

allocRange:length:()

- (bool) allocRange:		(BufferRange *)	range
length:		(NSUInteger)	length

begin()

- (void) begin

begin marks the beginning of a frame

convertFormat:from:to:()

- (void) convertFormat:		(RPixelFormat)	fmt
from:		(id<MTLTexture>)	src
to:		(id<MTLTexture>)	dst

Here is the call graph for this function:

drawQuadX:y:w:h:r:g:b:a:()

- (void) drawQuadX:		(float)	x
y:		(float)	y
w:		(float)	w
h:		(float)	h
r:		(float)	r
g:		(float)	g
b:		(float)	b
a:		(float)	a

draws a quad at the specified position (normalized coordinates) using the main render encoder

end()

- (void) end

end commits the command buffer

Here is the call graph for this function:

getStockShader:blend:()

- (id< MTLRenderPipelineState >) getStockShader:		(int)	index
blend:		(bool)	blend

initWithDevice:layer:library:()

- (instancetype) initWithDevice:		(id<MTLDevice>)	d
layer:		(CAMetalLayer *)	layer
library:		(id<MTLLibrary>)	l

Here is the call graph for this function:

newTexture:filter:()

- (Texture *) newTexture:		(struct texture_image)	image
filter:		(enum texture_filter_type)	filter

Here is the call graph for this function:

newTexture:mipmapped:()

- (id< MTLTexture >) newTexture:		(struct texture_image)	image
mipmapped:		(bool)	mipmapped

Here is the caller graph for this function:

readBackBuffer:()

- (bool) readBackBuffer:

(uint8_t *)

buffer

Here is the call graph for this function:

resetRenderViewport()

- (void) resetRenderViewport

resets the viewport for the main render encoder to the drawable size

Here is the call graph for this function:

Here is the caller graph for this function:

resetScissorRect()

- (void) resetScissorRect

resets the scissor rect for the main render encoder to the drawable size

setCaptureEnabled:()

- (void) setCaptureEnabled: (bool)  captureEnabled

implementation

setDisplaySyncEnabled:()

- (void) setDisplaySyncEnabled: (bool)  displaySyncEnabled

implementation

setRotation:()

- (void) setRotation:

(unsigned)

rotation

Here is the call graph for this function:

Here is the caller graph for this function:

setViewport:()

- (void) setViewport: (video_viewport_t *)  viewport

implementation

Here is the caller graph for this function:

Property Documentation

blitCommandBuffer

- (id< MTLCommandBuffer >) blitCommandBuffer

readnonatomicassign

Returns the command buffer used for pre-render work, such as mip maps and shader effects.

captureEnabled

- (bool) captureEnabled

readwritenonatomicassign

captureEnabled allows previous frames to be read

clearColor

- (MTLClearColor) clearColor

readwritenonatomicassign

commandBuffer

- (id<MTLCommandBuffer>) commandBuffer

readnonatomicassign

Returns the command buffer for the current frame.

device

- (id<MTLDevice>) device

readnonatomicassign

displaySyncEnabled

- (bool) displaySyncEnabled

readwritenonatomicassign

Specifies whether rendering is synchronized with the display.

library

- (id<MTLLibrary>) library

readnonatomicassign

nextDrawable

- (id< CAMetalDrawable >) nextDrawable

readnonatomicassign

rce

- (id< MTLRenderCommandEncoder >) rce

readnonatomicassign

Main render encoder to back buffer.

uniforms

- (Uniforms *) uniforms

readnonatomicassign

viewport

- (video_viewport_t *) viewport

readwritenonatomicassign

---

The documentation for this class was generated from the following files:

• gfx/common/metal/Context.h
• gfx/common/metal/Context.m