KudanAR - iOS  1.6.0
ARAlphaVideoMaterial Class Reference

#import <ARAlphaVideoMaterial.h>

Inherits ARMaterial.

Instance Methods

(instancetype) - initWithTexture:
 
- Instance Methods inherited from ARMaterial
(void) - postRender
 
(BOOL) - prepareRendererWithNode: [implementation]
 

Class Methods

(instancetype) + materialwithTexture:
 

Properties

ARVideoTexturetexture
 
- Properties inherited from ARMaterial
NSString * name
 
BOOL isTranslucent
 
ARBlendMode blendMode
 
BOOL depthTest
 
BOOL depthWrite
 
BOOL colourWrite
 
ARFaceCullMode cullMode
 
ARShaderProgramshaderProgram [implementation]
 

Detailed Description

A material used to render alpha videos as an ARVideoTexture. Alpha Videos are videos specially created using the Kudan AR Toolkit. They are a series of images that are in two halves, with the left half containing the colour frames of the image on a white background and the right half containing an alpha mask. When these frames are encoded using the Kudan AR Toolkit, the resulting video is a .mp4 file playing the frames at the specified frame rate. When rendered using the framework, the two halves are combined together and the resulting video with transparency is displayed on its associated node.

Method Documentation

◆ initWithTexture:

- (instancetype) initWithTexture: (ARVideoTexture *)  texture

Initialises an ARAlphaVideoMaterial object using an ARVideoTexture.

Example of use:

ARAlphaVideoMaterial *videoMaterial = [[ARAlphaVideoMaterial alloc] initWithTexture:texture];
Parameters
textureThe ARVideoTexture to initialise the class with.

◆ materialwithTexture:

+ (instancetype) materialwithTexture: (ARVideoTexture *)  texture

Class method that initialises and returns an instance of an ARAlphaVideoMaterial object.

Example of use:

ARAlphaVideoMaterial *videoMaterial = [ARAlphaVideoMaterial materialwithTexture:texture];

Property Documentation

◆ texture

- (ARVideoTexture*) texture
readwritenonatomicassign

The ARVideoTexture associated with this material. This is the video that will be played when the material is rendered.


The documentation for this class was generated from the following files:
ARAlphaVideoMaterial
Definition: ARAlphaVideoMaterial.h:14
ARAlphaVideoMaterial::texture
ARVideoTexture * texture
Definition: ARAlphaVideoMaterial.h:18