Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1.1 KB

search-global-solar-eclipse.md

File metadata and controls

21 lines (12 loc) · 1.1 KB

//astronomy/io.github.cosinekitty.astronomy/searchGlobalSolarEclipse

searchGlobalSolarEclipse

fun searchGlobalSolarEclipse(startTime: Time): GlobalSolarEclipseInfo

Searches for a solar eclipse visible anywhere on the Earth's surface.

This function finds the first solar eclipse that occurs after startTime. A solar eclipse may be partial, annular, or total. See GlobalSolarEclipseInfo for more information. To find a series of solar eclipses, call this function once, then keep calling nextGlobalSolarEclipse as many times as desired, passing in the peak value returned from the previous call.

See globalSolarEclipsesAfter for convenient iteration of consecutive eclipses.

Return

Information about the first solar eclipse after startTime.

Parameters

startTime The date and time for starting the search for a solar eclipse.