Function: LiEmissionSetWrite

LiEmissionSetWrite

Function

LtStatus

LiEmissionSetWrite(	`LtEmissionSet`	the_set
	`LtString`	file_name
	`LtEnum`	file_type
	)

Synopsis Write an emission set out to file.

Location lishpro

Parameters

`the_set`	Emission set to write out.
`file_name`	Photometric distribution data file.
`file_type`	Type of photometric distribution file.

Return Value

A status value.

Description

It is possible to generate an industry-standard photometric distribution file from any given emission set. This file can be utilised later as input for a goniometric light source shader if required. The final argument to this function expects an enumerated value which determines which format the file is to be written in. Allowed values for this argument are:

LI_EMISSION_SET_IESNA, \\ LI_EMISSION_SET_CIE, \\ LI_EMISSION_SET_CIBSE or \\ LI_EMISSION_SET_EULUMDAT. \\

If an attempt is made to write out a NULL emission set or to write to an invalid file then an error status will be returned.

Example


LtEmissionSet the_set = (LtEmissionSet)NULL ;
LtString      file_name = "out_file" ;
LtStatus      status = LI_STATUS_OK ;

/*
 * Create an emission set using LiEmissionSetCreate
 * then write it out to file in IESNA format.
 */

...

status = LiEmissionSetWrite( the_set, file_name, 
                             LI_EMISSION_SET_IESNA ) ;

See Also LiEmissionSetCopy
LiEmissionSetCreate
LiEmissionSetDebug
LiEmissionSetDestroy
LiEmissionSetEnquire
LiEmissionSetPreProcess
LiEmissionSetRead