mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Added documentation for some missing LittleFoot methods

Browse source
This commit is contained in:
ed 2017-03-15 10:19:53 +00:00
parent 2ca5a9c32b
commit 501d7299a6
2 changed files with 30 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

36
modules/juce_blocks_basics/LittleFootFunctions.txt
View file

@ -66,6 +66,18 @@ float map (float value, float sourceMin, float sourceMax);
*/
int mod (int dividend, int divisor);
/** Returns a random floating-point number.
@returns a random value in the range 0 (inclusive) to 1.0 (exclusive)
*/
float getRandomFloat();
/** Returns a random integer, limited to a given range.
@returns a random integer between 0 (inclusive) and maxValue (exclusive).
*/
int getRandomInt (int maxValue)
/** Returns the number of milliseconds since a fixed event (usually system startup).
This returns a monotonically increasing value which it unaffected by changes to the
@ -117,14 +129,24 @@ int getPortToMaster();
/** Returns the block type of the block with this ID. */
int getBlockTypeForID (int blockID);
/** Sends a message to the block with the specified ID. This will be processed in the handleMessage() callback.
/** Sends a message to the block with the specified ID.
This will be processed in the handleMessage() callback.
@param blockID the ID of the block to send this message to
@param data0 the first chunk of data to send
@param data1 the second chunk of data to send
@param data2 the third chunk of data to send
@param blockID the ID of the block to send this message to
@param param1 the first chunk of data to send
@param param2 the second chunk of data to send
@param param3 the third chunk of data to send
*/
void sendMessageToBlock (int blockID, int data0, int data1, int data2);
void sendMessageToBlock (int blockID, int param1, int param2, int param3);
/** Sends a message to the host.
To receive this the host will need to implement the Block::ProgramEventListener::handleProgramEvent() method.
@param param1 the first chunk of data to send
@param param2 the second chunk of data to send
@param param3 the third chunk of data to send
*/
void sendMessageToHost (int param1, int param2, int param3);
/** Combines a set of 8-bit ARGB values into a 32-bit colour and returns the result. */
int makeARGB (int alpha, int red, int green, int blue);
@ -320,4 +342,4 @@ void handleMIDI (int byte0, int byte1, int byte2);
@see sendMessageToBlock
*/
void handleMessage (int data0, int data1, int data2);
void handleMessage (int param1, int param2, int param3);

2
modules/juce_blocks_basics/blocks/juce_Block.h
View file

@ -222,7 +222,7 @@ public:
To receive the message the program must provide a littlefoot function called
handleMessage with the following form:
@code
void handleMessage (int param1, int param2)
void handleMessage (int param1, int param2, int param3)
{
// Do something with the two integer parameters that the app has sent...
}