AtomicNET : AtomicEngine Namespace

RenderSurface Class

%Color or depth-stencil surface that can be rendered into.

Syntax

public class RenderSurface : RefCounted

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from RefCounted.

Public Constructors

Documentation for this section has not yet been entered.
Construct with parent texture.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

[read-only]
Height int . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
LinkedDepthStencil RenderSurface . Documentation for this section has not yet been entered.
LinkedRenderTarget RenderSurface . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
NumViewports uint . Documentation for this section has not yet been entered.
[read-only]
ParentTexture Texture . Documentation for this section has not yet been entered.
[read-only]
RenderBuffer uint . Documentation for this section has not yet been entered.
[read-only]
Target uint . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
UpdateMode RenderSurfaceUpdateMode . Documentation for this section has not yet been entered.
[read-only]
UpdateQueued bool . Documentation for this section has not yet been entered.
[read-only]
Usage TextureUsage . Documentation for this section has not yet been entered.
[read-only]
Width int . Documentation for this section has not yet been entered.

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
CreateRenderBuffer (uint, uint, uint) : bool
Create renderbuffer that cannot be sampled as a texture. Only used on OpenGL.
static
csb_Atomic_RenderSurface_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
GetHeight () : int
Return height.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetLinkedDepthStencil () : RenderSurface
Return linked depth-stencil surface.
GetLinkedRenderTarget () : RenderSurface
Return linked color rendertarget.
GetNumViewports () : uint
Return number of viewports.
GetParentTexture () : Texture
Return parent texture.
GetRenderBuffer () : uint
Return OpenGL renderbuffer if created.
GetTarget () : uint
Return surface's OpenGL target.
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetUpdateMode () : RenderSurfaceUpdateMode
Return viewport update mode.
GetUsage () : TextureUsage
Return usage.
GetViewport (uint) : Viewport
Return viewport by index.
GetWidth () : int
Return width.
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsUpdateQueued () : bool
Return whether manual update queued. Called internally.
OnDeviceLost ()
Mark the GPU resource destroyed on graphics context destruction. Only used on OpenGL.
QueueUpdate ()
Queue manual update of the viewport(s).
Refs () : int
Return reference count. (Inherited from RefCounted.)
Release ()
Release surface.
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
ResetUpdateQueued ()
Reset update queued flag. Called internally.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetLinkedDepthStencil (RenderSurface)
Set linked depth-stencil surface.
SetLinkedRenderTarget (RenderSurface)
Set linked color rendertarget.
SetNumViewports (uint)
Set number of viewports.
SetUpdateMode (RenderSurfaceUpdateMode)
Set viewport update mode. Default is to update when visible.
SetViewport (uint, Viewport)
Set viewport.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

RenderSurface Constructor

Documentation for this section has not yet been entered.

Syntax

public RenderSurface (Texture parentTexture)

Parameters

parentTexture
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RenderSurface Constructor

Construct with parent texture.

Syntax

public RenderSurface (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CreateRenderBuffer Method

Create renderbuffer that cannot be sampled as a texture. Only used on OpenGL.

Syntax

public bool CreateRenderBuffer (uint width, uint height, uint format)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
format
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_RenderSurface_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_RenderSurface_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetHeight Method

Return height.

Syntax

public int GetHeight ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLinkedDepthStencil Method

Return linked depth-stencil surface.

Syntax

public RenderSurface GetLinkedDepthStencil ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLinkedRenderTarget Method

Return linked color rendertarget.

Syntax

public RenderSurface GetLinkedRenderTarget ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumViewports Method

Return number of viewports.

Syntax

public uint GetNumViewports ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetParentTexture Method

Return parent texture.

Syntax

public Texture GetParentTexture ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetRenderBuffer Method

Return OpenGL renderbuffer if created.

Syntax

public uint GetRenderBuffer ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTarget Method

Return surface's OpenGL target.

Syntax

public uint GetTarget ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetUpdateMode Method

Return viewport update mode.

Syntax

public RenderSurfaceUpdateMode GetUpdateMode ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetUsage Method

Return usage.

Syntax

public TextureUsage GetUsage ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetViewport Method

Return viewport by index.

Syntax

public Viewport GetViewport (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetWidth Method

Return width.

Syntax

public int GetWidth ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Height Property

Documentation for this section has not yet been entered.

Syntax

public int Height { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsUpdateQueued Method

Return whether manual update queued. Called internally.

Syntax

public bool IsUpdateQueued ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LinkedDepthStencil Property

Documentation for this section has not yet been entered.

Syntax

public RenderSurface LinkedDepthStencil { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LinkedRenderTarget Property

Documentation for this section has not yet been entered.

Syntax

public RenderSurface LinkedRenderTarget { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumViewports Property

Documentation for this section has not yet been entered.

Syntax

public uint NumViewports { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

OnDeviceLost Method

Mark the GPU resource destroyed on graphics context destruction. Only used on OpenGL.

Syntax

public void OnDeviceLost ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ParentTexture Property

Documentation for this section has not yet been entered.

Syntax

public Texture ParentTexture { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

QueueUpdate Method

Queue manual update of the viewport(s).

Syntax

public void QueueUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Release Method

Release surface.

Syntax

public void Release ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RenderBuffer Property

Documentation for this section has not yet been entered.

Syntax

public uint RenderBuffer { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ResetUpdateQueued Method

Reset update queued flag. Called internally.

Syntax

public void ResetUpdateQueued ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetLinkedDepthStencil Method

Set linked depth-stencil surface.

Syntax

public void SetLinkedDepthStencil (RenderSurface depthStencil)

Parameters

depthStencil
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetLinkedRenderTarget Method

Set linked color rendertarget.

Syntax

public void SetLinkedRenderTarget (RenderSurface renderTarget)

Parameters

renderTarget
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetNumViewports Method

Set number of viewports.

Syntax

public void SetNumViewports (uint num)

Parameters

num
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetUpdateMode Method

Set viewport update mode. Default is to update when visible.

Syntax

public void SetUpdateMode (RenderSurfaceUpdateMode mode)

Parameters

mode
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetViewport Method

Set viewport.

Syntax

public void SetViewport (uint index, Viewport viewport)

Parameters

index
Documentation for this section has not yet been entered.
viewport
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Target Property

Documentation for this section has not yet been entered.

Syntax

public uint Target { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

UpdateMode Property

Documentation for this section has not yet been entered.

Syntax

public RenderSurfaceUpdateMode UpdateMode { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

UpdateQueued Property

Documentation for this section has not yet been entered.

Syntax

public bool UpdateQueued { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Usage Property

Documentation for this section has not yet been entered.

Syntax

public TextureUsage Usage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Width Property

Documentation for this section has not yet been entered.

Syntax

public int Width { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0