Banuba SDK
Instance Methods | Class Methods | List of all members
BNBParameter Class Reference

Class, represent shader parameter. More...

#import <BNBParameter.h>

Inheritance diagram for BNBParameter:

Instance Methods

(nonnull NSString *) - getName
 
(void) - setInteger:
 set parameter integer value. More...
 
(int32_t) - getInteger
 return parameter int value. More...
 
(void) - setReal:
 set parameter real value. More...
 
(float) - getReal
 return parameter f32 value. More...
 
(void) - setX:
 set x of vec3/vec4 value only. More...
 
(void) - setY:
 set y of vec3/vec4 value only. More...
 
(void) - setZ:
 set z of vec3/vec4 value only. More...
 
(void) - setW:
 set w of vec4 value only. More...
 
(void) - setVector3:
 set parameter vec3 value. More...
 
(nonnull BNBVec3 *) - getVector3
 return parameter vec3 value. More...
 
(void) - setVector4:
 set parameter vec4 value. More...
 
(nonnull BNBVec4 *) - getVector4
 return parameter vec4 value. More...
 
(void) - setMat2x4:
 set parameter mat2x4 value. More...
 
(nonnull BNBMat2x4 *) - getMat2x4
 return parameter mat2x4 value. More...
 
(void) - setMat3x4:
 set parameter mat3x4 value. More...
 
(nonnull BNBMat3x4 *) - getMat3x4
 return parameter mat3x4 value. More...
 
(void) - setMat4x4:
 set parameter mat4x4 value. More...
 
(nonnull BNBMat4x4 *) - getMat4x4
 return parameter mat4x4 value. More...
 

Class Methods

(nullable BNBParameter *) + create:
 Fabric method for parameter creating. More...
 

Detailed Description

Class, represent shader parameter.

Definition at line 20 of file BNBParameter.h.

Method Documentation

◆ create:

+ (nullable BNBParameter *) create: (nonnull NSString *)  name

Fabric method for parameter creating.

Parameters
name(string): parameter name.
Returns
created parameter (parameter)

◆ getInteger

- (int32_t) getInteger

return parameter int value.

Throw is type is not equal type, which was added earlier.

◆ getMat2x4

- (nonnull BNBMat2x4 *) getMat2x4

return parameter mat2x4 value.

Throw is type is not equal type, which was added earlier.

◆ getMat3x4

- (nonnull BNBMat3x4 *) getMat3x4

return parameter mat3x4 value.

Throw is type is not equal type, which was added earlier.

◆ getMat4x4

- (nonnull BNBMat4x4 *) getMat4x4

return parameter mat4x4 value.

Throw is type is not equal type, which was added earlier.

◆ getName

- (nonnull NSString *) getName
Returns
parameter name (string)

◆ getReal

- (float) getReal

return parameter f32 value.

Throw is type is not equal type, which was added earlier.

◆ getVector3

- (nonnull BNBVec3 *) getVector3

return parameter vec3 value.

Throw is type is not equal type, which was added earlier.

◆ getVector4

- (nonnull BNBVec4 *) getVector4

return parameter vec4 value.

Throw is type is not equal type, which was added earlier.

◆ setInteger:

- (void) setInteger: (int32_t)  value

set parameter integer value.

Parameters
value(int)

◆ setMat2x4:

- (void) setMat2x4: (nonnull BNBMat2x4 *)  value

set parameter mat2x4 value.

Parameters
value(mat2x4)

◆ setMat3x4:

- (void) setMat3x4: (nonnull BNBMat3x4 *)  value

set parameter mat3x4 value.

Parameters
value(mat3x4)

◆ setMat4x4:

- (void) setMat4x4: (nonnull BNBMat4x4 *)  value

set parameter mat4x4 value.

Parameters
value(mat4x4)

◆ setReal:

- (void) setReal: (float)  value

set parameter real value.

Parameters
value(float)

◆ setVector3:

- (void) setVector3: (nonnull BNBVec3 *)  value

set parameter vec3 value.

Parameters
value(vec3)

◆ setVector4:

- (void) setVector4: (nonnull BNBVec4 *)  value

set parameter vec4 value.

Parameters
value(vec4)

◆ setW:

- (void) setW: (float)  value

set w of vec4 value only.

Parameters
value(f32)

◆ setX:

- (void) setX: (float)  value

set x of vec3/vec4 value only.

Parameters
value(f32)

◆ setY:

- (void) setY: (float)  value

set y of vec3/vec4 value only.

Parameters
value(f32)

◆ setZ:

- (void) setZ: (float)  value

set z of vec3/vec4 value only.

Parameters
value(f32)

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