This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:
  A
  B
  C
  D
  E
  F
  G
  I
  L
  M
  N
  O
  P
  R
  S
  T
  U
  W
     open all    |    close all

GUI Elements:
  B
  C
  I
  M
  P
  R
  S
  T
     open all    |    close all

GUI Interactions:
  B
  F
  H
  S
     open all    |    close all

GUI Layouts:
  L
     open all    |    close all

Games/Demos:
  M
     open all    |    close all

Third Party Libraries:
  P
  F
  Z
     open all    |    close all
Information about this Website / Informationen zu dieser Webseite:
In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module matrix [Version: v01]

This documentation describes the Prokee module interface.


Static Methods:
main
int matrix::main(int argc,char **argv)
Constructors
create
Element *matrix::create(uint16_t width,uint16_t height)
createElementMatrix
Element *matrix::createElementMatrix(uint16_t width,uint16_t height,uint16_t rows,uint16_t cols,Element *(*createElement)(void))
Destructor
destroy
void matrix::destroy(Element *elem)
Helpers
allElements_newInteraction
void matrix::allElements_newInteraction(Element *elem,void(*initializeFunction)(Element *elem))
allElements_setCallbackFunction
void matrix::allElements_setCallbackFunction(Element *elem,void(*setActionFunction)(Element *elem,void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context),void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context)
allElements_setCallbackMessage
void matrix::allElements_setCallbackMessage(Element *elem,void(*setActionMessage)(Element *elem,AbsThread *thr,uint32_t msgID,void *context),AbsThread *thr,uint32_t msgID,void *context)
allElements_setCallbackFunction2
void matrix::allElements_setCallbackFunction2(Element *elem,void(*setActionFunction)(Element *elem,uint8_t button,void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context),uint8_t button,void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context)
allElements_setCallbackMessage2
void matrix::allElements_setCallbackMessage2(Element *elem,void(*setActionMessage)(Element *elem,uint8_t button,AbsThread *thr,uint32_t msgID,void *context),uint8_t button,AbsThread *thr,uint32_t msgID,void *context)

Motivation

Static Methods

   main


Runs a test of the matrix element.

Signature:
int matrix::main(int argc,char **argv)

Parameters:
Type Name Direction Description
int argcThe number of command-line parameters.
char **argv[IN]The command-line parameters.

Return value:
Exit status.

   create


Creates a new matrix element.

Signature:
Element *matrix::create(uint16_t width,uint16_t height)

Parameters:
Type Name Direction Description
uint16_t widthThe width of the matrix in pixels.
uint16_t heightThe height of the matrix in pixels.

Return value:
Pointer to an Element structure.

   createElementMatrix


Creates a new matrix element.

Signature:
Element *matrix::createElementMatrix(uint16_t width,uint16_t height,uint16_t rows,uint16_t cols,Element *(*createElement)(void))

Parameters:
Type Name Direction Description
uint16_t widthThe width of the matrix in pixels.
uint16_t heightThe height of the matrix in pixels.
uint16_t rowsThe number of rows of the matrix.
uint16_t colsThe number of columns of the matrix.
Element *(*createElement)
(
   void
)
with typedef
TypeName
stdConstructorFunctioncreateElement
[IN] Element constructor function.
Parameters
void: no parameters
Return value
Pointer to an Element structure.

Return value:
Pointer to an Element structure.

   destroy


Destroys a matrix element.

This frees all resources associated with the Element.

Signature:
void matrix::destroy(Element *elem)

Parameters:
Type Name Direction Description
Element *elem[IN/OUT]Pointer to an Element structure.

   allElements_newInteraction


Signature:
void matrix::allElements_newInteraction(Element *elem,void(*initializeFunction)(Element *elem))

Parameters:
Type Name Direction Description
Element *elem[IN/OUT]Pointer to an Element structure.
void(*initializeFunction)
(
   Element *elem
)		[IN]
Parameters
elem: Pointer to an Element structure.

   allElements_setCallbackFunction


Signature:
void matrix::allElements_setCallbackFunction(Element *elem,void(*setActionFunction)(Element *elem,void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context),void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context)

Parameters:
Type Name Direction Description
Element *elem[IN/OUT]Pointer to an Element structure.
void(*setActionFunction)
(
   Element *elem,
   void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),
   void *context
)		[IN]
Parameters
elem: Pointer to an Element structure.
context:
Function-Pointer Parameter
actionFunction:
The action callback function
Parameters
elem: Pointer to an Element structure.
x:
y:
context:
void(*actionFunction)
(
   Element *elem,
   uint16_t x,
   uint16_t y,
   void *context
)		[IN]
Parameters
elem: Pointer to an Element structure.
x:
y:
context:
void *context

   allElements_setCallbackMessage


Signature:
void matrix::allElements_setCallbackMessage(Element *elem,void(*setActionMessage)(Element *elem,AbsThread *thr,uint32_t msgID,void *context),AbsThread *thr,uint32_t msgID,void *context)

Parameters:
Type Name Direction Description
Element *elem[IN/OUT]Pointer to an Element structure.
void(*setActionMessage)
(
   Element *elem,
   AbsThread *thr,
   uint32_t msgID,
   void *context
)		[IN]
Parameters
elem: Pointer to an Element structure.
thr:
msgID:
context:
AbsThread *thr
uint32_t msgID
void *context

   allElements_setCallbackFunction2


Signature:
void matrix::allElements_setCallbackFunction2(Element *elem,void(*setActionFunction)(Element *elem,uint8_t button,void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context),uint8_t button,void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),void *context)

Parameters:
Type Name Direction Description
Element *elem[IN/OUT]Pointer to an Element structure.
void(*setActionFunction)
(
   Element *elem,
   uint8_t button,
   void(*actionFunction)(Element *elem,uint16_t x,uint16_t y,void *context),
   void *context
)		[IN]
Parameters
elem: Pointer to an Element structure.
button:
context:
Function-Pointer Parameter
actionFunction:
The action callback function
Parameters
elem: Pointer to an Element structure.
x:
y:
context:
uint8_t button
void(*actionFunction)
(
   Element *elem,
   uint16_t x,
   uint16_t y,
   void *context
)		[IN]
Parameters
elem: Pointer to an Element structure.
x:
y:
context:
void *context

   allElements_setCallbackMessage2


Signature:
void matrix::allElements_setCallbackMessage2(Element *elem,void(*setActionMessage)(Element *elem,uint8_t button,AbsThread *thr,uint32_t msgID,void *context),uint8_t button,AbsThread *thr,uint32_t msgID,void *context)

Parameters:
Type Name Direction Description
Element *elem[IN/OUT]Pointer to an Element structure.
void(*setActionMessage)
(
   Element *elem,
   uint8_t button,
   AbsThread *thr,
   uint32_t msgID,
   void *context
)		[IN]
Parameters
elem: Pointer to an Element structure.
button:
thr:
msgID:
context:
uint8_t button
AbsThread *thr
uint32_t msgID
void *context

Copyright © 2017 - 2019 by Andreas Pollhammer